Beautiful multilingual API documentation theme for Hugo
Visit the demo site.
The client library used to build the ToC does not handle Unicode very well. To get around this in Hugo >= 0.62.2, put this in your site config:
[markup] [markup.goldmark] [markup.goldmark.parser] autoHeadingIDType = "github-ascii"
Note: this theme requires Hugo >= 0.56.0 to run. If you want to edit the SCSS styles, you need:
npm installto install requirements)
Most notable: This theme will use all the (non drafts) pages in the site and build a single-page API documentation. Using
weightin the page front matter is the easiest way to control page order.
If you want a different page selection, please provide your own
You can customize the look-and-feel by adding your own CSS variables in
assets/scss/docuapi_overrides.scss. See the exampleSite folder for an example.
You can override the layouts by providing some custom partials:
partials/hook_head_end.htmlis inserted right before the
headend tag. Useful for additional styles etc.
partials/hook_body_end.htmlwhich should be clear by its name.
partials/hook_left_sidebar_start.htmlthe start of the left sidebar
partials/hook_left_sidebar_end.htmlthe end of the left sidebar