A set of Hugo doc templates for launching open source content.
  • JavaScript 34.1%
  • HTML 30.4%
  • SCSS 25.2%
  • Perl 5.6%
  • Shell 4.2%
  • Other 0.5%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Richard van der Hoff f318855c78
Merge pull request #8 from zecakeh/docsy-0.14
Upgrade docsy to v0.14.3
2026-03-31 23:25:49 +01:00
.github Upgrade GitHub Actions for Node 24 compatibility (#2526) 2026-02-08 18:40:21 -05:00
.vscode Set version to 0.14.2-dev-001-over-main-20ff86e7, and more (#2542) 2026-02-11 11:34:24 -05:00
assets Release 0.14.3 preparation (#2569) 2026-02-17 18:55:51 -05:00
docsy.dev Release 0.14.3 preparation (#2569) 2026-02-17 18:55:51 -05:00
i18n Update Serbian (cyrillic & latin) (#2510) 2026-02-04 18:09:38 -05:00
images Images for Hugo Theme Gallery 2019-11-20 17:19:43 +00:00
layouts Merge tag 'v0.14.3' 2026-03-30 11:03:02 +02:00
scripts Console code blocks: output is no longer selectable; and code style changes (#2548) 2026-02-12 08:54:39 -05:00
static Tabpane: support persistence of all active tabs (#1611) 2023-07-13 13:11:07 -04:00
tasks Update blog and CL for 0.14.2, refactor contrib pages (#2550) 2026-02-12 13:09:38 -05:00
.editorconfig Create .editorconfig 2020-07-01 20:26:35 +09:00
.gitattributes [CI] Run npm test scripts under Linux and Windows (#1778) 2024-01-13 09:09:15 -05:00
.gitignore Add name attribute to search input (#2549) 2026-02-12 09:26:00 -05:00
.markdownlint-cli2.yaml Update 0.14.0 release docs, rework and improve project-styles section 2026-01-25 09:37:36 -05:00
.markdownlint.yaml Refactor navbar vars, anchors, and cover styles; update blog & CL (#2509) 2026-02-03 16:39:33 -05:00
.nvmrc Require min version of Node to be latest LTS version 2021-10-26 15:31:26 -04:00
.prettierignore Don't format _variables_forward.scss 2026-01-21 13:40:51 -05:00
.prettierrc.json Release v0.7.2 preparation (#1702) 2023-11-08 12:09:10 -05:00
AGENTS.md Reorganize SCSS, fix scroll padding, normalize blocks-shortcode heading IDs and keep old IDs as alias (#2505) 2026-02-02 10:11:01 -05:00
CHANGELOG.md Set version to 0.14.2-dev-001-over-main-20ff86e7, and more (#2542) 2026-02-11 11:34:24 -05:00
CONTRIBUTING.md Update blog and CL for 0.14.2, refactor contrib pages (#2550) 2026-02-12 13:09:38 -05:00
docker-compose.yaml Reorg NPM package dependencies, rename site folder to docsy.dev (#2337) 2025-10-16 06:25:04 -04:00
Dockerfile Reorg NPM package dependencies, rename site folder to docsy.dev (#2337) 2025-10-16 06:25:04 -04:00
go.mod Merge tag 'v0.13.0' into docsy-0.13.0 2025-12-28 16:27:06 +01:00
go.sum Update Bootstrap to 5.3.8 (#2316) 2025-09-29 13:15:57 -04:00
hugo.yaml Update 0.14 release notes, Hugo upgrade guide, style adjustments, and more (#2502) 2026-02-01 06:45:02 -05:00
LICENSE Create LICENSE 2018-10-09 19:45:02 +01:00
package.json Release 0.14.3 preparation (#2569) 2026-02-17 18:55:51 -05:00
postcss.config.js Remove browsers from PostCSS Config 2020-06-23 00:17:58 +09:00
README.md Merge tag 'v0.14.3' 2026-03-30 11:03:02 +02:00
theme.toml Update min Hugo version in theme config, and some UG copyedits (#2267) 2025-05-27 10:00:54 -04:00

Docsy

Note: This is standard docsy but with remote js/font files replaced with local copies.

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.

[!IMPORTANT] 🚧 IMPORTANT 🚧

The main branch is under development and not officially supported; use official Docsy releases. For full support details, see Official support limits.

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
    

    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 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.

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, 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

Contributing

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!

License

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