@brainhubeu/gatsby-docs-kit

Gatsby Docs Kit

Easy to Maintain Markdown/React Documentation Static Websites

Live code demo | Hire us

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.

Features

• 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.
• Static Progressive Web Apps - Gatsby.js builds the fastest possible website. You get code and data splitting out-of-the-box. Gatsby loads only the critical HTML, CSS, data, and JavaScript so your site loads as fast as possible. Once loaded, Gatsby prefetches resources for other pages so clicking around the site feels incredibly fast.
• 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

Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

Clone repository:

git clone [e-mail]:brainhubeu/gatsby-docs-kit.git && mv gatsby-docs-kit/example docs-www && rm -rf gatsby-docs-kit

Then run:

yarn install

Seed documentation (if you do not have any yet):

yarn seed

Run the local webserver via yarn develop;

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!.

Deploy

Ready to go? Want to deploy documentation to github pages? Run following command inside docs-www directory:

yarn deploy:gh