Skip to main content

Dox - Gatsby Theme

A Gatsby theme for creating documentation site.

Documentation made easy with Gatsby. 🎉

Features

  • 📖 MDX support
  • 💅 Theme UI support
  • 🎨 Syntax Highlighting
  • 📑 Navbar, Sidebar & Footer
  • 📱 Fully Responsive Design 💻

Installation

Install the gatsby-theme-dox package:

# with npm:
npm run --save gatsby-theme-dox
# with yarn:
yarn add gatsby-theme-dox

Usage

Add 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'
}
}
]
}

Theme Options

KeyDefault valueDescription
basePath/Root URL for the documentation site
contentPathcontent/docsLocation of documentation files
mdxtrueConfigure gatsby-plugin-mdx plugin (if your site already is using it, set false)