Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gregberge committed Apr 23, 2019
1 parent e239a0e commit 0781a52
Showing 1 changed file with 19 additions and 22 deletions.
41 changes: 19 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# smooth-doc

Common config & components to create Gatsby documentation of open source projects.
Gatsby theme for Smooth Code documentation website.

## Install

```sh
yarn add smooth-doc gatsby
yarn add smooth-doc gatsby react react-dom
```

## Setup Gatsby

```js
// gatbsy-config.js
const { getGatsbyConfig } = require('smooth-doc/config')

module.exports = getGatsbyConfig({
root: __dirname,
name: 'SVGR',
slug: 'svgr',
github: 'https://github.com/smooth-code/svgr',
menu: ['About', 'Usage', 'Configuring SVGR', 'Advanced'],
nav: [{ title: 'Usage', url: '/docs/' }],
})
```

```js
// gatbsy-node.js
const { getGatsbyNode } = require('smooth-doc/node')

module.exports = getGatsbyNode({
root: __dirname,
})
module.exports = {
__experimentalThemes: [
{
resolve: 'smooth-doc',
options: {
name: 'SVGR',
slug: 'svgr',
github: 'https://github.com/smooth-code/svgr',
menu: ['About', 'Usage', 'Configuring SVGR', 'Advanced'],
nav: [
{ title: 'Playground', url: '/playground/' },
{ title: 'Usage', url: '/docs/' },
],
},
},
],
}
```

## Folder structure
Expand Down

0 comments on commit 0781a52

Please sign in to comment.