History

Andrey Smirnov 7a88a02241 docs: show archived/pre-release banner based on version Also clean up some stuff we're not going to use. Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>		2022-03-24 22:01:23 +03:00
..
.github	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
assets	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
i18n	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
images	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
layouts	docs: show archived/pre-release banner based on version	2022-03-24 22:01:23 +03:00
static	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
userguide	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.editorconfig	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.gitignore	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.gitmodules	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.nvmrc	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.prettierrc.json	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
.s3deploy.yml	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
config.toml	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
CONTRIBUTING.md	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
LICENSE	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
netlify.toml	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
package.json	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
postcss.config.js	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
README.md	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00
theme.toml	docs: overhaul all the docs	2022-03-22 13:05:21 -04:00

README.md

Docsy

Docsy is a Hugo 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, 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.The Docsy Example Project is hosted at https://example.docsy.dev/. For real-life examples of sites that use Docsy (and their source repos), see our Examples page.

To use the Docsy theme for your own site:

(Recommended) Use the example project, which includes the Docsy theme as a submodule, as a template to create your project. You can customize this pre-configured basic site into your own Docsy themed site. Learn more...
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 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/. 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: you need the themesDir flag when running Hugo because the site files are inside the theme repo.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details