Gatsby Docs Kit
Easy to Maintain Markdown/React Documentation Static Websites
Gatsby Docs Kit is a set of tools, extending Gatsby to generate gorgeous documentation static website. Documentation source files are written in Markdown or as React components and configured with a single YAML/JSON5 configuration file.
- Write in Markdown - Save time and focus on your project's documentation content. Simply write docs with Markdown and Gatsby will generate a set of static html files ready to serve.
- Customize with Gatsby and React - Need something extra? Just create React component and voilà. You can do anything. Meanwhile Gatsby’s rich data plugin ecosystem will let you bring data from one or many other sources.
- Preview as you work - As you edit content, you see the resulting UI change in your local development environment browser without refreshing the page.
- Host anywhere - Gatsby Docs Kit builds completely static HTML sites that you can host on GitHub pages, Netlify, or anywhere else you choose
Try it out
git clone firstname.lastname@example.org:brainhubeu/gatsby-docs-kit.git && mv gatsby-docs-kit/example docs-www && rm -rf gatsby-docs-kit
Seed documentation (if you do not have any yet):
Run the local webserver via
The example site is available at http://localhost:8000. You should see the example site loaded in your web browser. Also visit http://localhost:8000/___graphql to explore your site's GraphQL data and schema.
Then go to
./docs to edit and write awesome docs!.
Ready to go? Want to deploy documentation to github pages? Run following command inside