mirror of https://github.com/onweru/compose.git
README.md
@@ -1,37 +1,28 @@ # Compose Compose is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. Compose is a [Hugo](https://gohugo.io/) docs theme, inspired by [forestry.io](forestry.io)'s. This is not an officially supported Google product. This project is actively being maintained. The theme provides a simple navigation & structure. ## Prerequisites  The following are basic prerequisites for using compose in your site: ## Installation - Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure you download the `_extended` version which supports sass. Install a recent release of the Hugo "extended" version; ideally versions `>= 0.61`. If you install from [hugo releases page](https://github.com/gohugoio/hugo/releases), download the `_extended` version, which supports sass. ## Example and usage ## Example You can find an example project that uses Compose in the [Compose Example Project repo](https://github.com/onweru/compose). The Compose Example Project is hosted at [https://example.Compose.dev/](https://example.Compose.dev/). You can find an example project that uses Compose in the [Compose Userguide](https://github.com/onweru/compose-userguide). To use the Compose theme for your own site: The Compose Example Project is hosted at [https://compose-docs.netlify.com](https://compose-docs.netlify.com). This project also stands as the theme's user guide. - (Recommended) Copy the [example project](https://github.com/onweru/compose), which includes the Compose theme as a submodule. You can customize this pre-configured basic site into your own Compose themed site. [Learn more...](https://github.com/onweru/compose) - Add Compose to your existing Hugo site repo's `themes` directory. You can either add Compose as a Git submodule, or clone the Compose theme into your project. > This guide covers the necessary bits. As the project evolves, the userguide will get more comprehensive See the [Compose Getting Started Guide](https://Compose.dev/docs/getting-started/) for details about the various usage options. ## Documentation Compose has its own user guide (using Compose, of course!) with lots more information about using the theme, which you can find at [https://Compose.dev/](https://Compose.dev/). Alternatively 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: 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/userguide/ cd compose/exampleSite/ hugo server --themesDir ../.. ```
