https://github.com/muniftanjim/gatsby-theme-dox

Documentation made easy with Gatsby. :tada:
https://github.com/muniftanjim/gatsby-theme-dox

documentation gatsby gatsby-plugin gatsby-theme

Last synced: 2 months ago
JSON representation

Documentation made easy with Gatsby. :tada:

• Host: GitHub
• URL: https://github.com/muniftanjim/gatsby-theme-dox
• Owner: MunifTanjim
• Created: 2019-07-22T17:15:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:56:02.000Z (about 2 years ago)
• Last Synced: 2024-10-25T07:13:10.118Z (3 months ago)
• Topics: documentation, gatsby, gatsby-plugin, gatsby-theme
• Language: JavaScript
• Homepage: https://gatsby-theme-dox.netlify.app
• Size: 4.42 MB
• Stars: 30
• Watchers: 2
• Forks: 11
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dox - Gatsby Theme

A Gatsby theme for creating documentation site.

Documentation made easy with Gatsby. :tada:

## Features

- :open_book: MDX support

- :nail_care: Theme UI support

- :art: Syntax Highlighting

- :bookmark_tabs: Navbar, Sidebar & Footer

- :iphone: Fully Responsive Design :computer:

## Installation

Install the `gatsby-theme-dox` package:

```sh

# 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:

```js

// 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:

```js

// 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`) |