Docsy is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This Docsy Example Project uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content, or use the theme in your projects like any other Hugo theme.
The theme is included in this project as a Git submodule:
▶ git submodule
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)
This Docsy Example Project is hosted at https://example.docsy.dev/.
You can find detailed theme instructions in the Docsy user guide: https://docsy.dev/docs/
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/my/example.git with your repo’s web URL:
git clone --recurse-submodules --depth 1 https://github.com/my/example.git
You can now edit your local versions of the site’s source files.
If you want to do SCSS edits and want to publish these, you need to install PostCSS
npm install
Once you've cloned or copied the site repo, from the repo root folder, run:
hugo server
You can run docsy-example inside a Docker
container, the container runs with a volume bound to the docsy-example
folder. This approach doesn't require you to install any dependencies other
than Docker and Docker Compose.
- Build the docker image
docker-compose build
- Run the built image
docker-compose up
NOTE: You can run both commands at once as
docker-compose up --build
while you are working.
- Verify work
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 the container, first identify the container ID with:
CTRL + C to terminate `docker-compose` process
That will terminate the container.
- Remove produced images
You can execute rm
to remove the produced images
docker-compose rm