A technical documentation site is a website that your users can visit to find the documentation for your technical project. Your documentation set contains all the information you think your users might need to engage with your project, from overviews that help them understand what the project is for, to instructions for specific tasks. Depending on the size of the project, a documentation set can be a page or two or an entire “book” with different types of information.
Most users don’t want to have to spend much time looking at docs - they want to try your great project! So how do you make sure your technical documentation set gives users what they need to easily understand your project and get things done? We think a good technical documentation set should be:
- Reliable: Is it true?
- Comprehensive: Does it have all the information your target users might need?
- Well-organized and navigable: Can the user find the information they need? Are similar types of information (all the information about a feature, all your reference information) grouped together?
If you have users around the world, you might also want to provide your content in multiple languages, and if you have an open source project, you’ll probably want your users to be able to contribute to the docs.
Once you have your content, you use a technical documentation site to publish your technical documentation set online for your users. In addition to your documentation, your site might also contain material like contact information, a blog, or information about how to contribute to the project.
Particularly when working with open source projects, it can be difficult to figure out how to turn all your product knowledge into a website that helps and engages your users. Enter Docsy!
Docsy gives you a theme for the Hugo static site generator, an established open source tool that builds ready-to-serve websites from a set of theme and content files. The Docsy theme provides you with useful stuff for a technical documentation site that isn’t your own content:
|Page layouts optimized for different content types
|Navigation, page menus, headers, landing pages, blog snippets, feedback links - you just provide the content.
|Organize your docs in logical folders and get instantly updated navigation to help your users find them.
|Builds on Hugo’s multi-language support to make it easy to create a site in multiple languages.
|Feedback, contribution, and contact links
|Let your users file issues and edit docs with a single click, or follow contact links to join you on Slack, Twitter, or mailing lists.
|Reusable snippets of HTML you can use to create alerts, image boxes, landing page blocks, and more.
|Use the theme as-is for a basic, clean design, or update a file or two to get your own look.
|Simple previews and deployment
|Because Docsy is a Hugo theme, you get all the advantages of building with Hugo - simple, fast local previews, and, depending on your deployment options, continuous deployment from GitHub or other Git providers.
Author your content in the Markdown or HTML and then immediately test it with Hugo’s local server. Once you are ready to publish, add that content to your project and deploy it to your site using any of Hugo’s supported options. Learn more…
The Docsy template currently includes built-in integration with the following tools:
- GitHub: Get in-page links directly to your GitHub repo and provide your users with a convenient pathway to providing feedback, opening issues, and even suggesting changes through Pull Requests.
- Google Analytics: Easily connect your Google Analytics account to your site.
- Google Custom Search: Use Google Custom Search for in-site search queries, or configure your site to search the web.
- Algolia DocSearch: Let your users search your site with Algolia DocSearch.
- Lunr: Local indexing and search for your site without the need for external search services.
You can configure the Docsy theme as much or as little as you like, anything from changing the colours and images to adding your own type of page layout. Learn more…
We believe a well-organized documentation set can really help your users find the information they need, when they need it - whether it’s a “Hello World” tutorial when they’re starting out or a single core task they need to do to finish a complicated app. We also believe that having well-organized docs help you create comprehensive docs, as it’s easier to see when you’re missing something important. Learn more…
Docsy also provides autogenerated site navigation based on how you organize your source files, so once you’ve organized your docs in folders in GitHub or other source control, you’ve got menus for your users to quickly reach the doc they need. Learn more…
Spend time setting up your technical documentation site once, and then focus on what you do best. We work closely with the Hugo team and have individuals actively maintaining the Docsy theme. You can easily get and apply Docsy updates to your site, as well as open feature requests to improve the template, or even add new behaviors. Learn more…
Because Docsy helps you create and serve a well-organized, navigable technical documentation set, it frees you up to create and maintain great reliable, comprehensive content that your users can enjoy and trust.
Docsy is an open source project and we love getting patches and contributions to make Docsy and its docs even better. We hope to continue to make improvements to the theme along with the Docsy community.
Visit our Issues to see what we’re currently working on. If there’s something you’d like to see in Docsy, please create an issue yourself - or assign yourself an issue if you’d like to fix or add something! See our contribution guidelines for more information.
You can find out how to update your site to the latest version of Docsy in Keeping the theme up to date.