Skip to main content
View plugin on GitHub
See starters using this

gatsby-theme-glossary

A minimalist Gatsby Theme for a glossary built with MDX and Theme UI.

Get up and running in seconds with a beautiful glossary so you can do what’s more important: define terminology.

image

Features

  • πŸ“‘ MDX files per letter
  • 🎨 Theme UI-based theming
  • πŸ“± Mobile friendly

Directory structure

glossary
β”œβ”€β”€ a.mdx
β”œβ”€β”€ b.mdx
β”œβ”€β”€ ...
└── z.mdx

Installation

yarn add gatsby-theme-glossary

Install as a starter

Name Command
Base gatsby new johno/gatsby-starter-glossary

Usage

// gatsby-config.js
module.exports = {
  plugins: [
    'gatsby-theme-glossary'
  ]
}

Options

Name Default Description
contentPath glossary Path to directory of glossary files
basePath glossary Path to render the glossary page

Customizing

The glossary itself can be customized in a few ways. You can change the description text, the layout, and even the theme.

Description

You can optionally include a description under the glossary title that can introduce/describe the glossary that will follow below. You can achieve this by shadowing the description.mdx file:

src/gatsby-theme-glossary/description.mdx

## Hey!

This is a custom description of my glossary.

Layout

gatsby-theme-glossary doesn’t use a layout because it’s intended that you shadow the layout component with your own so that it’s properly embedded in your site.

// src/gatsby-theme-glossary/components/layout.js
export { default } from '../../components/layout'

Theme

This theme uses Theme UI so you can read about how to customize the theme in the official docs.

License

MIT


Docs
Tutorials
Plugins
Blog
Showcase