Hugo as a documentation tool


#41

@digitalcraftsman

I’ve hacked your Material Docs theme to have the functionality I needed. I copied & pasted stuff from the Docker Docs theme until I got something that worked.

I am no HTML / CSS / JS wizard, but it works.

See my fork: https://github.com/LiaungYip/hugo-material-docs

Todo:

  • Make it look less awful

Implementation in /content/

The menu structure is defined in /config.toml:

[[menu.main]]
    name = "data"
    identifier = "datafilestagpages"
    parent = "listfilepages"
    
[[menu.main]]
    name = "ability"
    identifier = "datafilesability"
    parent = "datafilestagpages"
    
... dozens more ...

Then each page’s front matter points towards one of the pre-defined menu items in config.toml. Here’s content\datafilestagpages\datafilesability\appliedname.md:

+++
date = "2016-07-10"
title = "appliedname"
original_url = "listfilepages/datafilestagpages/datafilesability.html#appliedname"

[menu.main]
    identifier = "datafilesability_appliedname"
    parent = "datafilesability"
+++
# appliedname

## Status

Deprecated 6.05.01 - use FACT

... Rest of content follows ...

#42

@bep took the time to port the Slate theme to Hugo. It’s a great theme if you want to document API’s or related types of content. Give it a try.


#43

I’ve just released a first cut at a documentation theme, plain-docs.

It’s (eventually) intended for documentation sites that:

  • Have a lot of pages, and need nested menus for navigation.
  • Need to be browseable from a local file system, offline, without an internet connection.

Links below:


#44

This reminds me - I’ve been working on a Hugo documentation theme as spare time allows:

https://jimmyjames.github.io/justdocs/

I’d consider it in pre-beta stage at this point, but will try to get some more core features and improvements to out as time allows.


#45

An old thread but possibly worth keeping alive. There is a theme called docDock which looks like a decent way of producing searchable documentation.


#46

I know this is a bit old, but since your theme is so effective as it is beautiful I would like to request a repair on this issue: https://github.com/digitalcraftsman/hugo-material-docs/issues/84

It appears with HUGO v32 up to v34 on mac and win machines.


#47

I saw today that Pupil labs, which from what I understand makes open source tools for eye tracking, uses Hugo for their documentation. Perhaps their implementation might help some in this thread.

Here they discuss why they went from GitHub wiki to a Docs site with Hugo. Their actual documentation site is here: Docs.pupil-labs.com. And here is the GitHub repository.

Their docs site is by the way not only about code, but also hardware. That makes it a nice example compared with other only-code-focused docs.