Have you ever struggled with the process of creating documentation for an open source project? Do you have an open source project that's outgrown its README? Open source projects need great docs to succeed, but great open source doc sites aren't always easy to produce and share.
Google supports over
2000 open source projects, and there has been growing demand from these projects for tooling and guidance to help them write and publish their documentation. To meet this need we created
Docsy: a documentation website with templates and guidance for documentation, which we’re open sourcing to the public to use and help improve the tool.
Docsy builds on existing open source tools, like
Hugo, and our experience with open source docs, providing a fast and easy way to stand up an OSS documentation website with features specifically designed to support technical documentation. Special features include everything from site navigation to multi-language support – with easy
site deployment options provided by Hugo. We also created guidance on how to add additional pages, structure your documentation, and accept community contributions, all with the goal of letting you focus on creating great content.
Who’s using it?
The
Kubeflow,
Knative, and
Agones websites were built using the Docsy theme, with more projects in the pipeline. We’ve also created an
example site that uses lots of Docsy features for you to explore and copy.
Ready to get started?
Visit the
Docsy site to find out how to create your first site with Docsy! You can either use Docsy like a regular
Hugo theme, or clone our
example site. Docsy is an open source project—of course—and we welcome your issues, suggestions, and
contributions!
