truenas / documentation

TrueNAS Documentation Hub

Welcome to the TrueNAS Documentation Repository! The collected documentation for TrueNAS software, hardware, and TrueCommand is stored here. These files are used to build the TrueNAS Documentation Hub available at https://www.truenas.com/docs/.

Software documentation is released under the Creative Commons license.

Technologies

• CommonMark and HTML governs the syntax for content files.
• Hugo (extended version) builds the website from the content files and governs the file organization, naming, front matter, and some of the shortcode syntax.
• The custom GeekDocs theme provides a bare-bones theme with templates and shortcodes for styling the website and content.
• Specific .css customizations are added on top of GeekDocs in the /static/custom.css, /data/menu/, and /layouts/ files

Local Build Process

1. Download Hugo Extended from https://github.com/gohugoio/hugo/releases/ and install. See these instructions for manually installing the Hugo extended version in WSL: https://sal.as/post/install-hugo-on-wsl/

2. Download this repository.

3. Open the downloaded repository and run Hugo with hugo serve. When complete, a local copy of the website is available by entering localhost:1313 in a browser address bar.