mirror of https://github.com/onweru/compose.git

edit | blame | history | raw

Compose

Compose is a Hugo theme for documentation sites, that provide simple navigation & structure.

Prerequisites

The following are basic prerequisites for using compose in your site:

  • Install a recent release of the Hugo "extended" version (we recommend version 0.61 or later). If you install from the
    release page, make sure you download the _extended version
    which supports sass.

Example and usage

You can find an example project that uses Compose in the Compose Example Project repo.

The Compose Example Project is hosted at https://compose-docs.netlify.com. This project also stands as the 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), making sure you have installed all the prerequisites listed above:

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.

edit | blame | history | raw
MIT License

Copyright (c) 2020 Weru

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.github/ISSUE_TEMPLATE/bug_report 773 b
.github/ISSUE_TEMPLATE/feature_request 558 b
.github/pull-request_template 429 b
CODE_OF_CONDUCT 857 b
README 2 KB
exampleSite/README 183 b
exampleSite/content/_index 1 KB
exampleSite/content/blog/_index 22 b
exampleSite/content/blog/creating-a-new-theme 47 KB
exampleSite/content/blog/emoji-support 2 KB
exampleSite/content/blog/goisforlovers 10 KB
exampleSite/content/blog/hugoisforlovers 3 KB
exampleSite/content/blog/migrate-from-jekyll 7 KB
exampleSite/content/docs/_index 612 b
exampleSite/content/docs/clarity/_index 387 b
exampleSite/content/docs/clarity/blogging 2 KB
exampleSite/content/docs/clarity/customize 6 KB
exampleSite/content/docs/clarity/features 705 b
exampleSite/content/docs/clarity/getting-started 2 KB
exampleSite/content/docs/clarity/images 4 KB
exampleSite/content/docs/clarity/syntax-highlighting 2 KB
exampleSite/content/docs/clarity/theme-overrides 2 KB
exampleSite/content/docs/compose/_index 307 b
exampleSite/content/docs/compose/customize 3 KB
exampleSite/content/docs/compose/github-actions 761 b
exampleSite/content/docs/compose/graphs-charts-tables 3 KB
exampleSite/content/docs/compose/install-theme 3 KB
exampleSite/content/docs/compose/mermaid 16 KB
exampleSite/content/docs/compose/organize-content 1 KB
exampleSite/content/docs/compose/search 3 KB
exampleSite/content/docs/compose/shortcodes-example 2 KB
exampleSite/content/docs/compose/shortcodes 6 KB
exampleSite/content/docs/compose/use-tina-cms 2 KB
exampleSite/content/search 58 b
exampleSite/content/tutorials/_index 547 b
exampleSite/content/tutorials/example/_index 324 b
exampleSite/content/tutorials/example/mermaid 8 KB