Skip to content
Documentation made easy with Gatsby. 🎉
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
theme
.eslintrc.json
.gitignore
.prettierrc
README.md
netlify.toml
package.json
yarn.lock

README.md

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

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)
You can’t perform that action at this time.