Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.82 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.82 KB

Compose

Compose is a Hugo theme for documentation websites. The theme provides a simple navigation & structure.

Hugo Compose Theme

Features

  1. Documentation
  2. Gallery Support
  3. Native lazy loading of images
  4. Live search
  5. Flowcharts, Piecharts, doughnut & bar charts support
  6. Searchable & Sortable tables
  7. Syntax highlighting
  8. Mermaid Support

Documentation

ExampleSite

The exampleSite serves as this theme's user guide .

This guide covers the necessary bits. As the project evolves, the user-guide will get more comprehensive

You can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes).

git clone --recurse-submodules --depth 1 https://github.com/onweru/compose.git
cd compose/exampleSite/
hugo server --themesDir ../..

Also built by Weru

  1. Clarity Theme
  2. Newsroom Theme
  3. Swift Theme
  4. Browse Theme

License

This theme is available under the MIT license.