A Hugo theme for documentation sites.
Compose is a Hugo theme designed specifically for documentation websites. It offers a simplistic navigation and structure for easy organization of content.
Documentation Gallery Support: Compose theme provides support for creating a documentation gallery with the ability to showcase images.
Native lazy loading of images: The theme incorporates native lazy loading of images, ensuring improved page loading speed.
Live search: Compose theme includes live search functionality, allowing users to easily find the information they need.
Flowcharts, Piecharts, doughnut & bar charts support: The theme supports various types of charts, including flowcharts, piecharts, doughnut charts, and bar charts.
Searchable and Sortable tables: Compose theme enables the creation of tables that can be easily searched and sorted for better user experience.
Syntax highlighting: The theme offers syntax highlighting, making code snippets more readable and user-friendly.
Mermaid Support: Compose theme integrates Mermaid, a JavaScript-based diagramming library, for creating charts and diagrams.
To install the Compose theme, follow these steps:
Use Hugo to generate and serve a local copy of the guide. This will also be useful for testing local theme changes.
Customize your site by configuring the search functionality and utilizing shortcodes.
If you prefer to use a content management system (CMS), the theme is compatible with the Forestry CMS.
Compose is a Hugo theme specifically designed for documentation websites. It offers a range of features including a documentation gallery, native lazy loading of images, live search, support for various types of charts, searchable and sortable tables, syntax highlighting, and integration with Mermaid for creating charts and diagrams. The theme can be easily installed and customized, and it is available under the MIT license.
