https://github.com/jlengstorf/gatsby-theme-simple-docs

A Gatsby theme for creating docs from a folder full of Markdown files.
https://github.com/jlengstorf/gatsby-theme-simple-docs

docs gatsby gatsby-theme gatsbyjs markdown

Last synced: 22 days ago
JSON representation

A Gatsby theme for creating docs from a folder full of Markdown files.

• Host: GitHub
• URL: https://github.com/jlengstorf/gatsby-theme-simple-docs
• Owner: jlengstorf
• Created: 2019-02-09T03:47:57.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-07T22:19:08.000Z (over 5 years ago)
• Last Synced: 2024-10-11T13:29:32.222Z (about 1 month ago)
• Topics: docs, gatsby, gatsby-theme, gatsbyjs, markdown
• Language: JavaScript
• Homepage: https://simple-docs-theme-test.netlify.com/
• Size: 207 KB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gatsby Theme: Simple Docs

Use this theme you want to quickly create docs from a folder full of Markdown files.

## Install

```sh

# Create a new directory for your site.

mkdir mydocssite

# Move into the directory.

cd mydocssite/

# Create a `package.json`.

yarn init -y

# Add dependencies

yarn add react react-dom gatsby gatsby-theme-simple-docs

# Create a `gatsby-config.js`.

touch gatsby-config.js

```

Inside `gatsby-config.js`, set up the theme:

```js

module.exports = {

  __experimentalThemes: ['gatsby-theme-simple-docs']

};

```

Start the server:

```sh

npx gatsby develop

```