@inthepocket/hubble-docs-theme

Hubble Docs Theme

The Hubble documentation Gatsby configuration.

Report Bug · Request Feature

Table of Contents

• About Hubble Docs Theme
  • Built With
• Getting Started
  • Installation
• Usage
• License

About Hubble Docs Theme

hubble-docs-theme manages the Gatsby dependencies for all documentation sites created with the hubble-docs-starter.

Here's why:

• We can remotely maintain Gatsby plugin versions and configurations
• We can add functionality for all existing & new documentation websites

hubble-docs-theme is maintained in the hubble-docs mono-repo

Built With

The Hubble documentation repository uses

• Gatsby

Getting Started

If you scaffolded a new Gatsby website using the hubble-docs-starter, the hubble-docs-theme plugin should already be properly installed. If you're adding the plugin/theme to an existing Gatsby configuration, please follow the steps below.

Installation

1. Install the package in your project

npm i @inthepocket/hubble-docs-theme --save

2. Configure the plugin in gatsby-config.js

const path = require(`path`);

module.exports = {
  plugins: [
    {
      resolve: `@inthepocket/hubble-docs-theme`,
      options: {
        pagesPath: `${__dirname}/src/markdown-pages`,
        imagesPath: `${__dirname}/src/assets/images`,
        siteMetadata: {
          title: `Hubble documentation`,
          description: `Static site boilerplate generated with Gatsby.`
        }
      }
    }
  ]
};

3. Make sure you created the /src/markdown-pages and /src/assets/images folders in your project.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

License

Distributed under the MIT License.