A minimalist Gatsby Theme for documentation sites built with MDX and Theme UI.
Get up and running in seconds with a beautiful docs site so you can do what's more important: write docs.
- ๐ MDX files for JSX in Markdown
- ๐จ Theme UI-based theming
- ๐ป Syntax highlighting
- ๐ฐ MDX-based sidebar navigation
- ๐ฃ Automatic readme routing
- ๐งฉ Shortcode support with React components
- ๐ Collapsible menu
- ๐ฑ Mobile friendly
- ๐ฃ Custom docs schema
yarn add gatsby-theme-documentation
Name | Command |
---|---|
Base | gatsby new johno/gatsby-starter-documentation |
Dark | gatsby new johno/gatsby-starter-documentation-dark |
Tomato | gatsby new johno/gatsby-starter-documentation-tomato |
// gatsby-config.js
module.exports = {
plugins: [
'gatsby-theme-documentation'
]
}
gatsby-theme-documentation
uses a sidebar.mdx
file to populate the navigation.
In order to customize it you can shadow it by creating a file at
src/gatsby-theme-documentation/sidebar.mdx
.
- [Introduction](/introduction/)
- [Getting Started](/getting-started/)
- [GitHub](https://github.com/johno/gatsby-theme-documentation)
Similarly to sidebar customization, you can also change the header content by
writing MDX. You can shadow the default header by creating a file at
src/gatsby-theme-documentation/header.mdx
# ![Docs Logo](https://contrast.now.sh/white/black?width=80&height=40&text=DOCS)
- [GitHub](https://github.com/johno/gatsby-theme-documentation)
- [Twitter](https://twitter.com/4lpine)
You can add shortcodes to your docs site which can be used throughout
your docs pages by extending the components passed to MDXProvider. You
can do this by using component shadowing and creating the following file
in the root of your project: src/gatsby-theme-documentation/components.js
.
import baseComponents from 'gatsby-theme-documentation/src/components'
import MyCustomH1 from '../components/my-custom-h1'
export default {
...baseComponents,
h1: MyCustomH1
}
In order to get documents rendered in directories on GitHub, it's common
to specify a readme.md
similarly to the index.html
on normal websites.
Since this theme is meant to work seamlessly with docs directories on GitHub,
file/path/readme.md
will be automatically turned into /file/path/index.html
in the built site. Links will also be redirected to support the new url scheme.
This theme creates a Docs
type which can be queried as
an individual document or a collection. This data can be
used to create additional pages, create summaries, etc.
{
docs(slug: {eq: "/some-page"}) {
slug
body
}
}
{
allDocs {
slug
}
}