Setting up a Documentation Website for your Software Project with Hugo and Netlify

• Hugo

  548 72,452 9.8 Go

  The world’s fastest framework for building websites.

  

Congratulations! Your new Hugo site is created in /home/erika/Projects/mydocs. Just a few more steps and you're ready to go: 1. Download a theme into the same-named folder. Choose a theme from https://themes.gohugo.io/ or create your own with the "hugo new theme " command. 2. Perhaps you want to add some content. You can add single files with "hugo new /.". 3. Start the built-in live server via "hugo server". Visit https://gohugo.io/ for quickstart guide and full documentation.

• hugo-geekdoc

  4 482 9.0 HTML

  Hugo theme made for documentation

  

cd mydocs/ mkdir -p themes/hugo-geekdoc/ curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• yamldocs

  4 14 4.1 PHP

  Discontinued YAML docs - markdown generator

  

For this tutorial, we'll use the Geekdoc theme, the same I have set up for the yamldocs documentation.

• Read the Docs

  33 7,872 9.7 Python

  The source code that powers readthedocs.org

  

Readthedocs + mkdocs: this is a good combination using the free documentation platform Readthedocs. You get a free .readthedocs subdomain, and can also set up a custom domain. I use it for the Minicli docs, overall a good solution but I find it to be a bit flaky sometimes, specially when there are updates.

Suggest a related project