diff options
author | LisaFC <lcarey@google.com> | 2019-07-03 14:28:40 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-03 14:28:40 +0300 |
commit | 87a6c8c3f83ca1a43c64aa59c658c12151e7b941 (patch) | |
tree | 7963188eb6a2702287e337bab765d811eff4c38d /README.md | |
parent | db73772eb663430bff1848d2f06e643ce236c2f0 (diff) |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 47 |
1 files changed, 17 insertions, 30 deletions
@@ -4,33 +4,14 @@ Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, pr This is not an officially supported Google product. This project is actively being maintained. - -## Prerequisites and installation +## Prerequisites The following are basic prerequisites for using Docsy in your site: -<!-- TODO: Update to docsy.dev URL --> -See the -[Docsy Getting Started Guide](https://docsydocs.netlify.com/docs/getting-started/) for -details about the various installation options. - -To use the Docsy theme in your site: - - 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 SCSS. -- Get the Docsy theme: - - - (Recommended) Copy the [Docsy Example](https://github.com/google/docsy-example) - project, which includes the Docsy theme as a submodule. - You can customize this pre-configured basic site into your own Docsy themed site. - [Learn more...](https://github.com/google/docsy-example) - - - Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or - clone the Docsy theme into your project. See the complete list of - [Docsy installation options](https://docsydocs.netlify.com/docs/getting-started/). - - Install `PostCSS` so that the site build can create the final CSS assets. You can install it locally by running the following commands from the root directory of your project: @@ -39,19 +20,29 @@ To use the Docsy theme in your site: sudo npm install -D --save postcss-cli ``` -## Usage and documentation +## Example and usage <!-- TODO: Update to docsy.dev URL --> You can find an example project that uses Docsy in the [Docsy Example Project repo](https://github.com/google/docsy-example). The Docsy Example Project is hosted at [https://goldydocs.netlify.com/](https://goldydocs.netlify.com/). -To use the Docsy theme, you can either: +To use the Docsy theme for your own site: -* Copy and edit the example project’s repo, which will also give you a skeleton structure for your top-level and documentation sections, or -* 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. + - (Recommended) Copy the [example project](https://github.com/google/docsy-example), + which includes the Docsy theme as a submodule. + You can customize this pre-configured basic site into your own Docsy themed site. + [Learn more...](https://github.com/google/docsy-example) + + - Add Docsy to your existing Hugo site repo's `themes` directory. You can either add Docsy as a Git submodule, or + clone the Docsy theme into your project. + +<!-- TODO: Update to docsy.dev URL --> +See the [Docsy Getting Started Guide](https://docsydocs.netlify.com/docs/getting-started/) for +details about the various usage options. + +## Documentation <!-- TODO: Update to docsy.dev URL --> -Docsy also has its own user guide (using Docsy, of course!), which you can find at [https://docsydocs.netlify.com/](https://docsydocs.netlify.com/). Alternatively you can use Hugo to generate and serve a local copy (also useful for testing local theme changes), making sure you have installed all the prerequisites listed below: +Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsydocs.netlify.com/](https://docsydocs.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/google/docsy.git @@ -60,7 +51,3 @@ hugo server --themesDir ../.. ``` Note that you need the `themesDir` flag because the site files are inside the theme repo. - -<!-- TODO: Update to docsy.dev URL --> -You can find out much more about using Docsy in the [user guide](https://docsydocs.netlify.com/). - |