Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onweru/compose
A Hugo theme for documentation sites.
https://github.com/onweru/compose
algolia-search documentation-theme fuse hugo hugo-theme search
Last synced: 5 days ago
JSON representation
A Hugo theme for documentation sites.
- Host: GitHub
- URL: https://github.com/onweru/compose
- Owner: onweru
- License: mit
- Created: 2020-01-28T20:17:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T14:22:07.000Z (3 months ago)
- Last Synced: 2024-11-30T12:05:38.568Z (12 days ago)
- Topics: algolia-search, documentation-theme, fuse, hugo, hugo-theme, search
- Language: JavaScript
- Homepage: https://composedocs.netlify.app
- Size: 17.9 MB
- Stars: 316
- Watchers: 7
- Forks: 100
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - onweru/compose - A Hugo theme for documentation sites. (others)
README
# Compose
Compose is a [Hugo](https://gohugo.io/) theme for documentation websites. The theme provides a simple navigation & structure.
## 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
- [Install Compose theme](https://composedocs.netlify.app/docs/compose/install-theme/)
- [Use Tina CMS](https://composedocs.netlify.app/docs/compose/use-tina-cms/)
- [Customize your site](https://composedocs.netlify.app/docs/compose/customize/)
- [Configure search](https://composedocs.netlify.app/docs/compose/search/)
- [Shortcodes](https://composedocs.netlify.app/docs/compose/shortcodes/)
- [Mermaid](https://composedocs.netlify.app/docs/compose/mermaid/)
## ExampleSite
The [exampleSite](https://github.com/onweru/compose/tree/master/exampleSite) serves as this theme's [user guide](https://composedocs.netlify.app/docs/compose/install-theme/) .
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](https://github.com/chipzoller/hugo-clarity)
2. [Newsroom Theme](https://github.com/onweru/newsroom)
3. [Swift Theme](https://github.com/onweru/hugo-swift-theme)
4. [Browse Theme](https://github.com/onweru/browse)
## License
This theme is available under the [MIT license](https://github.com/onweru/compose/blob/master/LICENSE).