From 568553394d0a8b34668a75c9839a0f1f426469b2 Mon Sep 17 00:00:00 2001 From: Dimitri Staessens Date: Sun, 6 Oct 2019 21:10:46 +0200 Subject: theme: Switch to docsy theme --- themes/docsy/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 themes/docsy/README.md (limited to 'themes/docsy/README.md') diff --git a/themes/docsy/README.md b/themes/docsy/README.md new file mode 100644 index 0000000..89dde4e --- /dev/null +++ b/themes/docsy/README.md @@ -0,0 +1,50 @@ +# Docsy + +Docsy is a [Hugo](https://gohugo.io/) theme for technical documentation sets, providing simple navigation, site structure, and more. + +This is not an officially supported Google product. This project is actively being maintained. + +## Prerequisites + +The following are basic prerequisites for using Docsy 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. + +- 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: + + ``` + sudo npm install -D --save autoprefixer + sudo npm install -D --save postcss-cli + ``` + +## Example and usage + +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://example.docsy.dev/](https://example.docsy.dev/). + +To use the Docsy theme for your own site: + + - (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. + +See the [Docsy Getting Started Guide](https://docsy.dev/docs/getting-started/) for +details about the various usage options. + +## Documentation + +Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at [https://docsy.dev/](https://docsy.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: + +``` +git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git +cd docsy/userguide/ +hugo server --themesDir ../.. +``` + +Note that you need the `themesDir` flag when running Hugo because the site files are inside the theme repo. -- cgit v1.2.3