update

weru

04.58.2020 de3ec7fa1b95b35c680a523734a67e02900fd19a

update

 README.md

@@ -6,7 +6,7 @@

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

- Install a recent release of the Hugo "extended" version (we recommend version 0.53 or later). If you install from the 
- Install a recent release of the Hugo "extended" version (we recommend version 0.61 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.

@@ -14,22 +14,14 @@

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/).

To use the Compose theme for your own site:

  - (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.

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:
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-docs.netlify.com](https://compose-docs.netlify.com). 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:

```
git clone --recurse-submodules --depth 1 https://github.com/onweru/compose.git
cd compose/userguide/
cd compose/exampleSite/
hugo server --themesDir ../..
```


 theme.toml

@@ -2,11 +2,11 @@
license = "MIT"
licenselink = "https://github.com/google/compose/blob/master/LICENSE"
description = "A Hugo theme for technical documentation sites"
homepage = "https://compose.netlify.com"
tags = ["documentation", "simple", "customizable", "responsive", "docs"]
features = []
min_version = 0.53
homepage = "https://compose-docs.netlify.com"
tags = ["documentation", "simple", "customizable", "docs"]
features = ["docs", "search"]
min_version = 0.61

[author]
  name = "Weru"
  homepage = "https://compose.netlify.com"
  homepage = "https://compose-docs.netlify.com"