0.8.4 • Published 4 years ago
@reflexjs/gatsby-theme-doc v0.8.4
@reflexjs/gatsby-theme-doc
Use this theme to build documentation pages. See example at https://reflexjs.org/docs.
Installation
npm i @reflexjs/gatsby-theme-doc
Configuration
// gatsby-config.js
module.exports = {
plugins: [`@reflexjs/gatsby-theme-doc`],
}
Options
// gatsby-config.js
module.exports = {
plugins: [
{
resolve: `@reflexjs/gatsby-theme-doc`,
options: {
contentPath: "content/docs",
basePath: "/docs",
},
},
],
}
Data models
Doc
type Doc implements Node @dontInfer {
id: ID!
title: String
excerpt: String
slug: String
body: String
tableOfContents: JSON
timeToRead: Int
}
Usage
Place your docs inside content/docs
as follows.
site
└── content
└── docs
└── 01-getting-started.mdx
You must prefix each filename with a number followed by a hyphen (-
). This will assign it a weight that will determine its order in the nav.
Then add a nav for your docs inside content/navs
as follows.
site
└── content
└── navs
└── doc.mdx
Then add content to your doc:
---
title: A page
excerpt: Omnis architecto praesentium itaque eaque quasi.
---
Write markdown or use components here.
## Heading 2
<Button bg="primary">Button</Button>
0.8.4
4 years ago
0.8.3
4 years ago
0.8.2
4 years ago
0.8.1
5 years ago
0.8.0
5 years ago
0.7.1
5 years ago
0.7.0
5 years ago
0.6.0
5 years ago
0.5.3
5 years ago
0.5.2
5 years ago
0.5.0
5 years ago
0.5.1
5 years ago
0.4.2
5 years ago
0.4.1
5 years ago
0.4.0
5 years ago
0.3.2
5 years ago
0.3.3
5 years ago
0.3.1
5 years ago
0.3.0
5 years ago
0.2.3
5 years ago
0.2.2
5 years ago
0.2.1
5 years ago
0.2.0
5 years ago
0.1.9
5 years ago
0.1.8
5 years ago
0.1.7
5 years ago
0.1.6
5 years ago
0.1.1
5 years ago
0.1.0
5 years ago