diff options
author | LisaFC <lcarey@google.com> | 2018-10-09 21:40:38 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-09 21:40:38 +0300 |
commit | 25ec1b683bc25dbe968ae0128b3bc1f976f693a5 (patch) | |
tree | d42cfd3e321f167fba5d7504f0138d6bbd6db606 /README.md | |
parent | 1c9c6311a1fa6da250c3cc99f5c0f5724f66db72 (diff) |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 32 |
1 files changed, 14 insertions, 18 deletions
@@ -1,10 +1,16 @@ -# Tech Doc Hugo +# Docsy -Hugo theme and skeleton project. +Docsy is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more. -## Installation +You can find an example site project that uses Docsy in [Docsy-Example](https://github.com/google/docsy-example). To use the Docsy Hugo theme, you can either: -You need a recent version of Hugo to run this project (preferably 0.45+). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure to get the `extended` Hugo version. Alternatively, on macOS you can install via Brew. +* Copy and edit the example site’s repo, which will also give you a skeleton structure for your top-level and documentation sections. +* Specify the Docsy theme like any other [Hugo theme](https://gohugo.io/themes/installing-and-using-themes/). + when creating or updating your site. This gives you all the theme-y goodness but you’ll need to specify your own site structure. + +## Installation and prerequisites + +You need a recent version of Hugo to build sites using this theme (preferably 0.45+). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure to get the `extended` Hugo version which supports SCSS. Alternatively, on macOS you can install Hugo via Brew. If you want to do stylesheet changes, you will also need `PostCSS` to create the final assets. You can also install it locally with: @@ -12,22 +18,12 @@ If you want to do stylesheet changes, you will also need `PostCSS` to create the npm install ```` -Clone the repo using: - -``` -git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo.git -``` - -## Running the website locally - -From the repo root folder, run: +To use a local version of the theme files, clone the repo using: ``` -hugo server +git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git ``` +## Theme documentation -Navigate to http://localhost:1313/td/docs/theme-documentation/ to read the theme documentaton. - - - +Detailed documentation for this theme is in the [Docsy example site](https://github.com/google/docsy-example) under **Documentation - Getting Started**. |