bb4L / compose

A Hugo theme for documentation sites. It's inspired by https://forestry.io/docs/welcome/

Home Page:https://docs.neuralvibes.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Compose

Compose is a Hugo theme for documentation websites, inspired by forestry.io's docs page. The theme provides a simple navigation & structure.

Hugo Compose Theme

Features

  1. Documentation
  2. Gallery Support (via shortcode)
  3. Native lazy loading of images
  4. Live search
  5. Pie, doughnut & bar charts support
  6. Searchable & Sortable tables
  7. Syntax highlighting

Run your site with compose theme

ExampleSite

The exampleSite serves as this theme's user guide .

This guide covers the necessary bits. As the project evolves, the userguide 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 ../..

Note that you need the themesDir flag when running Hugo because the site files are inside the theme repo.

From the same creator

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

License

This theme is available under the MIT license.

About

A Hugo theme for documentation sites. It's inspired by https://forestry.io/docs/welcome/

https://docs.neuralvibes.com

License:MIT License


Languages

Language:JavaScript 47.2%Language:HTML 30.0%Language:Sass 22.9%