Docsy is a Hugo theme module for technical documentation sites, providing easy site navigation, structure, and more. This Docsy Example Project uses the Docsy theme component as a hugo module and provides a skeleton documentation structure for you to use. You can clone/copy this project and edit it with your own content, or use it as an example.
In this project, the Docsy theme component is pulled in as a Hugo module, together with other module dependencies:
$ hugo mod graph hugo: collected modules in 566 ms hugo: collected modules in 578 ms github.com/google/docsy-example github.com/google/[email protected] github.com/google/docsy-example github.com/google/docsy/[email protected] github.com/google/docsy/[email protected] github.com/twbs/[email protected]+incompatible github.com/google/docsy/[email protected] github.com/FortAwesome/[email protected]
You can find detailed theme instructions in the Docsy user guide.
This is not an officially supported Google product. This project is currently maintained.
A simple way to get started is to use this project as a template, which gives you a site project that is set up and ready to use. To do this:
Click Use this template.
Select a name for your new project and click Create repository from template.
Make your own local working copy of your new repo using git clone, replacing https://github.com/me/example.git with your repo’s web URL:
git clone --depth 1 https://github.com/me/example.git
You can now edit your own versions of the site’s source files.
If you want to do SCSS edits and want to publish these, you need to install
Once you've made your working copy of the site repo, from the repo root folder, run:
You can run docsy-example inside a Docker
container, the container runs with a volume bound to the
folder. This approach doesn't require you to install any dependencies other
than Docker Desktop on
Windows and Mac, and Docker Compose
Build the docker image
Run the built image
NOTE: You can run both commands at once with
docker-compose up --build.
Verify that the service is working.
Open your web browser and type
http://localhost:1313 in your navigation bar,
This opens a local instance of the docsy-example homepage. You can now make
changes to the docsy example and those changes will immediately show up in your
browser after you save.
To stop Docker Compose, on your terminal window, press Ctrl + C.
To remove the produced images run:
For more information see the Docker Compose documentation.
As you run the website locally, you may run into the following error:
➜ hugo server INFO 2021/01/21 21:07:55 Using config file: Building sites … INFO 2021/01/21 21:07:55 syncing static files to / Built in 288 ms Error: Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68" not found in file cache
This error occurs if you have not installed the extended version of Hugo. See this section of the user guide for instructions on how to install Hugo.
Or you may encounter the following error:
➜ hugo server Error: failed to download modules: binary with name "go" not found
This error occurs if you have not installed the
go programming language on your system.
See this section of the user guide for instructions on how to install