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-cliin the CLI.
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/
The next step is to clone this repo. To clone the repo in your current directory, type
git clone https://github.com/freenas/documentation.gitin 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
Finally, the documentation website is ready to be built locally. cd into the cloned repo. To
build the website locally, type
hugo servein the CLI.
After building the website with hugo serve, access it by entering
localhost:1313 in a browser address bar.