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.
The main branch is under development and not officially supported; use
official Docsy releases. For full support details, see Official support
limits.
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
Starting in
version 8 of postcss-cli,
you must also separately install postcss:
npm install -D postcss
Any additional prerequisites depend on the installation option you choose. We recommend using Docsy as a Hugo module, which requires that you have the Go language installed in addition to Hugo and PostCSS.
For complete prerequisites and instructions, see our Get started guides.
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 and templates 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. You can add Docsy as a Hugo module, as a Git submodule, or clone the Docsy theme into your project.
See the Get started guides for details about the various usage options.
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.
Maintainers: you can access deploy logs, the deploy preview of
main, and more from the Deploys section of 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
npm install
npm run serve
For details on our code of conduct and the process for submitting pull requests, see CONTRIBUTING.md. Thank you to all past, present, and future contributors!
This project is licensed under the Apache License 2.0, see LICENSE for details.