Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 3.05 KB

README.md

File metadata and controls

83 lines (61 loc) · 3.05 KB
Raw

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. If you install from the Hugo 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:

    $ npm install --save-dev autoprefixer
$ npm install --save-dev 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 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 Hugo module, 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. It is hosted by Netlify at docsy.dev. For deploy logs and more, see Deploys from the site's Netlify dashboard.

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 --depth 1 https://github.com/google/docsy.git
$ cd docsy/userguide/
$ npm install
$ npm run serve

Contributing GitHub

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 GitHub

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