Home

Gatsby Just Docs allows you to put the focus on writing documentation, while giving you powerful styling options.

Getting Started

Dependencies

Gatsby Just Docs is built for GatsbyJS, a React-based static site generator. Just the docs requires no additional setup beyond what's normal expected when setting up a Gatsby site locally. For more details into how Gatsyby works, check out their quick start guide.

Running Locally

Running Gatsby Just Docs isnt any different then any other Gatsby based site, and can be up and running in just a few commands:

git clone git@github.com:underlost/gatsby-just-docs.git
cd gatsby-just-docs
yarn install
yarn dev

Production

Gatsby Just Docs has been tested to run in just about any enviroment a normal GatsbyJS can run, such as Netlify or Gatsby Cloud.

If youre looking to host the site on more traditional host, run

yarn build

to create a public folder that you can then upload anywhere!

Configuring

Gatsby Just Docs has a number of helpful settings. Refer to the configuration section for all options available.

About the project

Just The Docs is © 2022 by Tyler Rilling

Contributing

Contributions and feedback are welcome and encouraged. Check out our contributing guidelines on how to do so.

License

Just the Docs is distributed by an MIT license.