Skip to content

MunifTanjim/gatsby-theme-dox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

30 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

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 install --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)