Code Monkey home page Code Monkey logo

documentation's Introduction

Actions Status Preview Build

How To: Hugo Local Build

The documentation repository can be downloaded locally. This may be desired if you prefer using a specific text editor other than the in-browser Github editor to develop content.

Part of the theme requires PostCSS. To install PostCSS, a recent version of NodeJS must be installed on your machine so that you can use npm. Once installed, type

sudo npm install -D --save autoprefixer
sudo npm install -D --save postcss-cli

in the CLI.

Download Hugo

First, download the extended version of Hugo from https://github.com/gohugoio/hugo/releases/. Follow the Hugo install instructions for the appropriate operating system.

See these instructions for manually installing the Hugo extended version in WSL: https://sal.as/post/install-hugo-on-wsl/

Clone Documentation Repo

The next step is to clone this repo. To clone the repo in your current directory, type

git clone https://github.com/freenas/documentation.git

in the CLI.

Note: To update your current local branch with any changes that have been merged into the master branch, run
`git pull origin master

Build Locally

Finally, the documentation website is ready to be built locally. cd into the cloned repo. To build the website locally, type

hugo serve

in the CLI.

After building the website with hugo serve, access it by entering localhost:1313 in a browser address bar.

documentation's People

Contributors

a-stjohn avatar aijamalnk avatar apaperclip avatar asmacdo avatar bep avatar chenopis avatar dependabot[bot] avatar dkmullen avatar emckean avatar kaycebasques avatar kmoore134 avatar kshithijiyer avatar lisafc avatar mrt134 avatar q5sys avatar rionam avatar sarahmaddox avatar sharifsalah avatar squall1721 avatar theletterf avatar thorsteneb avatar ykzts avatar zackarywelch avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.