(Recommended) Use the example project,
which includes the Docsy theme as a submodule, as a template to create your project.
You can customize this pre-configured basic site into your own Docsy themed site.
Add Docsy to your existing Hugo site repo’s themes directory. You can either add Docsy as a Git submodule, or
clone the Docsy theme into your project.
Docsy has its own user guide (using Docsy, of course!) with lots more information about using the theme, which you can find at https://docsy.dev/. 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 --recurse-submodules --depth 1 https://github.com/google/docsy.git
hugo server --themesDir ../..
Note: you need the themesDir flag when running Hugo because the site files are inside the theme repo.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See also the list of contributors who participated in this project.
This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details