I wanted to set up a documentation site for a new project I've been working on. I wanted something modern, with a great design, that also supported MDX. Something that also had a grate styling framework to easily build new, beautiful looking components as needed. I loved the look of Just The Docs, but didnt like the limitations of Jekyll and regular markdown. As I started to port the theme over to Gatsby, I took the oppertunity to add new features, like better darkmode support, and PrismJS syntax highlight.
- Write in MDX
- Optional, realtime Search powered by Algoria
- Dark mode theme, with toggle functionality. Settings even persist through page refresh!
- Fully customizable CSS framework, useful for easily building out new components, with classes similar to Bootstrap.
- Live code editor. Render react components for live editing!
- Easy deployment on Netlify or with Docker.
- Edit on Github
- Syntax Highlighting using Prism
- Progressive Web App, Works Offline
- SEO friendly- Set meta title and meta descriptions for pages.
- Google Analytics support
View the demo, and all of its features in the live demo. Hosted on Netlify.
Get started by running the following commands:
git clone [email protected]:underlost/gatsby-just-docs.git
cd gatsby-just-docs
yarn install
yarn devVisit http://localhost:8000/ to view the app.
- Code based on gatsby-gitbook-starter
- Styling based on Just The Docs
- Javascript framework by GatsbyJS
Contributions and feedback are welcome and encouraged. Check out our contributing guidelines on how to do so.
The theme is available as open source under the terms of the MIT License.