adoralaura/compose-theme

Forked from https://github.com/onweru/compose

Find a file

Adora Laura Kalb 263ba0d329 add fork		2024-07-26 17:08:59 +02:00
assets	add fork	2024-07-26 17:08:59 +02:00
dist	add fork	2024-07-26 17:08:59 +02:00
exampleSite	add fork	2024-07-26 17:08:59 +02:00
i18n	add fork	2024-07-26 17:08:59 +02:00
images	add fork	2024-07-26 17:08:59 +02:00
layouts	add fork	2024-07-26 17:08:59 +02:00
static	add fork	2024-07-26 17:08:59 +02:00
.gitignore	add fork	2024-07-26 17:08:59 +02:00
CODE_OF_CONDUCT.md	add fork	2024-07-26 17:08:59 +02:00
go.mod	add fork	2024-07-26 17:08:59 +02:00
LICENSE	add fork	2024-07-26 17:08:59 +02:00
README.md	add fork	2024-07-26 17:08:59 +02:00
theme.toml	add fork	2024-07-26 17:08:59 +02:00

README.md

Compose

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

Features

Documentation
Gallery Support
Native lazy loading of images
Live search
Flowcharts, Piecharts, doughnut & bar charts support
Searchable & Sortable tables
Syntax highlighting
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

License

This theme is available under the MIT license.