The Chicago Docs theme for Gatsby is a modern and professional docs site for small open source projects. It was designed to be readable, easy to navigate, and accessible.
Install the starter
gatsby new your-site-name https://github.com/kabartolo/gatsby-starter-chicago-docs
The Chicago Docs theme includes
- SASS and CSS modules
- Code highlighting with
- Dark and light modes
- Code blocks with live preview, line numbers, and line highlighting, as well as a title, copy button, and language selection
- Documentation search
- Several components for displaying your docs, such as a property table
Features currently in development:
- Support for Algolia DocSearch
- Support for OpenAPI definitions and code generation
All components include regular class names, so you can customize the site using plain CSS if you prefer.
A mark of good reference documentation is how easy it is to skim for the information a user needs. Docs in this theme are written in MDX, and the theme comes with several components that help present your docs in a way that makes them easy to scan. These are used throughout this demo, and the Example API Doc offers a complete demonstration.