DocuAPI is a beautiful multilingual API documentation theme for Hugo. This theme is built on top of the beautiful work of Robert Lord and others on the Slate project (Apache 2 License).
Note: this theme requires Hugo >= 0.56.0 to run. If you want to edit the SCSS styles, you need:
- The extended Hugo version.
- PostCSS CLI: npm install -g postcss-cli (TODO(bep) add a package.json)
See the exampleSite and more specific its site configuration for the available options.
Most notable: This theme will use all the (non drafts) pages in the site and build a single-page API documentation. Using
weight in 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.
When the fix for #2549 is released we may do this with blocks, but until then you can provide 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