Docuapi

Overview

Netlify StatusDocuAPI is a multilingual API documentation theme for Hugo. It is built on top of the Slate project and has recently been rewritten using AlpineJS.

Features

• Multilingual API documentation theme
• Built on top of the Slate project
• Recently rewritten from jQuery to AlpineJS

Installation

1. Import the theme in your Hugo config.
2. If you want the older jQuery version, replace the path with github.com/bep/docuapi.
3. To edit the SCSS styles, you need the extended Hugo version and PostCSS CLI. Run npm install to install the requirements.
4. Refer to the exampleSite’s site configuration for the available options.
5. Use the weight property in the page front matter to control the page order.
6. If you want a different page selection, provide your own layouts/index.html template.
7. Customize the look-and-feel by adding your own CSS variables in assets/scss/docuapi_overrides.scss. See the exampleSite folder for an example.

Summary

Netlify StatusDocuAPI is a multilingual API documentation theme for Hugo. It is built on top of the Slate project and has recently been rewritten using AlpineJS. The theme allows you to easily create a single-page API documentation using the available options and page order control. It also provides customization options for the look-and-feel of the documentation.