A Gatsby theme for creating documentation site.
Documentation made easy with Gatsby. 🎉
- 📖 MDX support
- 💅 Theme UI support
- 🎨 Syntax Highlighting
- 📑 Navbar, Sidebar & Footer
- 📱 Fully Responsive Design 💻
Install the gatsby-theme-dox package:
# with npm:
npm install --save gatsby-theme-dox
# with yarn:
yarn add gatsby-theme-doxAdd the gatsby-theme-dox pacakge in your gatsby-config.js file:
// gatsby-config.js
module.exports = {
siteMetadata: {
title: `Dox - Gatsby Theme`,
description: 'Documentation made easy with Gatsby',
author: 'MunifTanjim'
},
plugins: [`gatsby-theme-dox`]
}You can also pass a options object if you want:
// gatsby-config.js
module.exports = {
plugins: [
{
resolve: 'gatsby-theme-dox',
options: {
basePath: '/',
contentPath: 'docs'
}
}
]
}| Key | Default value | Description |
|---|---|---|
basePath |
/ |
Root URL for the documentation site |
contentPath |
content/docs |
Location of documentation files |
mdx |
true |
Configure gatsby-plugin-mdx plugin (if your site already is using it, set false) |