Newer
Older
Whitney Armstrong
committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
title: 'Getting started'
---
The best way yo start is by using our starter:
```bash
gatsby new rocket-docs https://github.com/rocketseat/gatsby-starter-theme-docs
```
But, if you prefer, you can install and configure manually.
```bash
# Using Yarn:
yarn add @rocketseat/gatsby-theme-docs
# Using NPM:
npm i @rocketseat/gatsby-theme-docs
```
## Theme Options
| Key | Default | Required | Description |
| ---------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| basePath | / | No | Root url for all docs |
| configPath | config | No | Location of config files |
| docsPath | docs | No | The site description for SEO and social (FB, Twitter) tags |
| githubUrl | - | No | The complete URL of your repository. For example: `https://github/rocketseat/gatsby-themes` |
| baseDir | - | No | If your Gatsby site does not live in the root of your project directory/git repo, pass the subdirectory name here (ex: `docs`) |
## Example usage
```js title=gatsby-config.js
module.exports = {
siteMetadata: {
siteTitle: `@rocketseat/gatsby-theme-docs`,
defaultTitle: `@rocketseat/gatsby-theme-docs`,
siteTitleShort: `gatsby-theme-docs`,
siteDescription: `Out of the box Gatsby Theme for creating documentation websites easily and quickly`,
siteUrl: `https://rocketdocs.netlify.com`,
siteAuthor: `@rocketseat`,
siteImage: `/banner.png`,
siteLanguage: `en`,
themeColor: `#7159c1`,
},
plugins: [
{
resolve: `@rocketseat/gatsby-theme-docs`,
options: {
docsPath: `src/docs`,
basePath: `/`,
},
},
],
};
```
Once you have installed the dependencies you will need to create the [navigation](/usage/navigation) and [documentation](/usage/creating-docs) file.
After that, you are ready 🚀