https://github.com/marekbrainhub/gatsby-docs-kit-starter

Easy to Maintain Markdown/React Documentation Static Websites - starter
https://github.com/marekbrainhub/gatsby-docs-kit-starter

Last synced: 9 days ago
JSON representation

Easy to Maintain Markdown/React Documentation Static Websites - starter

• Host: GitHub
• URL: https://github.com/marekbrainhub/gatsby-docs-kit-starter
• Owner: marekbrainhub
• License: mit
• Created: 2018-06-21T09:24:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-22T09:44:58.000Z (over 6 years ago)
• Last Synced: 2024-11-06T20:49:58.455Z (12 days ago)
• Language: JavaScript
• Size: 1.53 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gatsby Docs Kit Starter

The default Brainhub static docs starter.

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

Then run:

```bash

yarn install

```

Seed documentation (if you don't 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 GraphiQL 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:

```bash

yarn deploy:gh

```