Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brainhubeu/gatsby-docs-kit
📃Easy to Maintain Markdown/React Documentation Static Websites
https://github.com/brainhubeu/gatsby-docs-kit
gatsby github-page prismjs react react-components react-helmet react-live sass
Last synced: 18 days ago
JSON representation
📃Easy to Maintain Markdown/React Documentation Static Websites
- Host: GitHub
- URL: https://github.com/brainhubeu/gatsby-docs-kit
- Owner: brainhubeu
- License: mit
- Created: 2018-06-11T11:49:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T19:38:11.000Z (27 days ago)
- Last Synced: 2024-11-17T15:05:08.734Z (25 days ago)
- Topics: gatsby, github-page, prismjs, react, react-components, react-helmet, react-live, sass
- Language: JavaScript
- Homepage: https://brainhub.eu/
- Size: 4.18 MB
- Stars: 126
- Watchers: 7
- Forks: 16
- Open Issues: 61
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docs - Gatsby Docs Kit
README
Gatsby Docs Kit
Easy to Maintain Markdown/React Documentation Static Websites
[](https://circleci.com/gh/brainhubeu/gatsby-docs-kit)
[](https://github.com/brainhubeu/gatsby-docs-kit/commits/master)
[](https://github.com/brainhubeu/gatsby-docs-kit/blob/master/LICENSE)
[](http://makeapullrequest.com)
[](https://renovatebot.com/)
[](https://www.npmjs.com/package/@brainhubeu/gatsby-docs-kit)
[](https://github.com/brainhubeu/gatsby-docs-kit/commits/master)
[](https://www.npmjs.com/package/@brainhubeu/gatsby-docs-kit)
[](https://www.npmjs.com/package/@brainhubeu/gatsby-docs-kit)
[](https://github.com/brainhubeu/gatsby-docs-kit/graphs/contributors)
Gatsby Docs Kit is a set of tools, extending [Gatsby](https://www.gatsbyjs.org/) 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](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well.
Clone repository:
```bash
git clone [email protected]:brainhubeu/gatsby-docs-kit.git && mv gatsby-docs-kit/example docs-www && rm -rf gatsby-docs-kit
```
Then run:
```bash
yarn install
```
Seed documentation (if you do not have any yet):
```bash
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:
```bash
yarn deploy:gh
```