Docsy

[![npm version][npm-badge]][npm-package]

Docsy, a [Linux Foundation][] project, is a Hugo theme for technical documentation sites, providing simple navigation, site structure, and more.

[!IMPORTANT] 🚧 IMPORTANT 🚧

> The main branch is under development and not officially supported; use

official Docsy [releases][]. For full support details, see [Official support

limits][official-support].

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

• Provide the Dart Sass compiler, which Hugo

• Install PostCSS so that the site build can create the final CSS assets. You

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.

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 and templates page.

To use the Docsy theme for your own site:

• (Recommended) Use the

• Add Docsy to your existing Hugo site. You can add Docsy as an NPM package, as

See the Get started guides 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.

Maintainers: you can access deploy logs, the [deploy preview of main][main-preview], 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/docsy/docsy.git
cd docsy
npm run install:safe
npm run serve

npm scripts in this repo run under Bash on every platform (script-shell pin in .npmrc): on Windows, make sure Git Bash's bash is on your PATH.

Contributing

Docsy is governed by its [Technical Charter][] as Docsy a Series of LF Projects, LLC, and follows the LF Projects [code of conduct][]. For how to contribute, see the [contributing guide][].

Thank you to all past, present, and future [contributors][]!

License

This project is licensed under the Apache License 2.0, see LICENSE for details.

[code of conduct]: https://lfprojects.org/policies/code-of-conduct/ [contributing guide]: https://www.docsy.dev/docs/contributing/ [contributors]: https://github.com/docsy/docsy/graphs/contributors [deploys]: https://app.netlify.com/sites/docsydocs/deploys [Linux Foundation]: https://www.linuxfoundation.org/ [main-preview]: https://main--docsydocs.netlify.app/ [netlify]: https://netlify.com [npm-badge]: https://img.shields.io/npm/v/%40docsy%2Ftheme [npm-package]: https://www.npmjs.com/package/@docsy/theme [official-support]: https://www.docsy.dev/project/about/changelog/#official-support [releases]: https://github.com/docsy/docsy/releases [Technical Charter]: https://github.com/docsy/docsy/blob/main/docsy-technical-charter.pdf