# @committed/gatsby-theme-docs
Latest version **3.3.0** (published 2021-12-10) · MIT license · 0 weekly downloads
## Install
```sh
npm install @committed/gatsby-theme-docs
pnpm add @committed/gatsby-theme-docs
yarn add @committed/gatsby-theme-docs
bun add @committed/gatsby-theme-docs
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.3.0 |
| Published | 2021-12-10 |
| First published | 2019-11-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 30 |
| Unpacked size | 71.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Committed |
| Maintainers | chrisflatley, commitd_jon, stuarthendren, devil-ci |
## Links
- npm: https://www.npmjs.com/package/@committed/gatsby-theme-docs
- Repository: https://github.com/commitd/docs
- Homepage: https://github.com/commitd/docs#readme
- Issues: https://github.com/commitd/docs/issues
- npm.io page: https://npm.io/package/@committed/gatsby-theme-docs
## Dependencies (30)
- [prismjs](https://npm.io/package/prismjs.md) ^1.24.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^10.0.0
- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^1.6.22
- [remark-slug](https://npm.io/package/remark-slug.md) ^6.0.0
- [react-helmet](https://npm.io/package/react-helmet.md) ^6.1.0
- [remark-emoji](https://npm.io/package/remark-emoji.md) ^2.2.0
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) ^1.6.22
- [typeface-lato](https://npm.io/package/typeface-lato.md) ^1.1.13
- [typeface-dosis](https://npm.io/package/typeface-dosis.md) ^1.1.13
- [@material-ui/lab](https://npm.io/package/@material-ui/lab.md) ^4.0.0-alpha.56
- [lodash.startcase](https://npm.io/package/lodash.startcase.md) ^4.4.0
- [@committed/layout](https://npm.io/package/@committed/layout.md) ^4.2.0
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.11.0
- [gatsby-plugin-mdx](https://npm.io/package/gatsby-plugin-mdx.md) ^2.8.0
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.11.2
- [react-hotkeys-hook](https://npm.io/package/react-hotkeys-hook.md) ^3.3.2
- [gatsby-plugin-sharp](https://npm.io/package/gatsby-plugin-sharp.md) ^3.8.0
- [gatsby-plugin-layout](https://npm.io/package/gatsby-plugin-layout.md) ^2.8.0
- [gatsby-remark-images](https://npm.io/package/gatsby-remark-images.md) ^5.5.0
- [react-use-flexsearch](https://npm.io/package/react-use-flexsearch.md) ^0.1.1
- [@committed/components](https://npm.io/package/@committed/components.md) ^4.2.1
- [gatsby-remark-mermaid](https://npm.io/package/gatsby-remark-mermaid.md) ^2.1.0
- [gatsby-remark-prismjs](https://npm.io/package/gatsby-remark-prismjs.md) ^5.5.0
- [gatsby-plugin-typescript](https://npm.io/package/gatsby-plugin-typescript.md) ^3.8.0
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^3.8.0
- [gatsby-plugin-material-ui](https://npm.io/package/gatsby-plugin-material-ui.md) ^3.0.1
- [gatsby-plugin-local-search](https://npm.io/package/gatsby-plugin-local-search.md) ^2.0.1
- [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^4.8.0
- [gatsby-remark-autolink-headers](https://npm.io/package/gatsby-remark-autolink-headers.md) ^4.5.0
- [gatsby-remark-copy-linked-files](https://npm.io/package/gatsby-remark-copy-linked-files.md) ^4.5.0
## Recent versions
- 3.3.0 (latest) — 2021-12-10
- 3.2.2 — 2021-12-09
- 3.2.1 — 2021-12-09
- 3.2.0 — 2021-12-09
- 3.1.0 — 2021-07-01
- 3.0.0 — 2021-06-30
- 2.1.2 — 2020-06-12
- 2.1.1 — 2020-06-08
- 2.1.0 — 2020-05-20
- 2.0.0 — 2020-05-13
- 1.0.7 — 2019-12-10
- 1.0.6 — 2019-12-09
- 1.0.5 — 2019-12-09
- 1.0.4 — 2019-12-05
- 1.0.3 — 2019-12-05
- … 3 more at https://npm.io/package/@committed/gatsby-theme-docs/versions
## README
Committed Gatsby Theme for Docs
[](https://committed.io)
A theme for writing documentation sites in Markdown.
## 🔥 Features
- Write using Markdown / [MDX](https://github.com/mdx-js/mdx)
- Committed style theme
- Syntax Highlighting using Prism
- Automatically generated sidebar navigation, previous/next
- Diagrams using mermaid
- emojis using :shortcodes:
- SEO friendly
- Fully customizable
- 🔍 Search
- Use links that work in github
## 🔗 Live Demo and Instructions
Here's a [live demo](https://docs.committed.software)
## 🚀 Quickstart
Get started by adding the dependencies:
```bash
npm add @committed/gatsby-theme-docs gatsby react react-dom
```
Add or create a `.gitignore`:
```
public/
.cache/
node_modules/
```
Configure in `gatsby-config.js` with your site metadata e.g.
```javascript
module.exports = {
siteMetadata: {
title: 'Title',
author: 'Author',
description: 'Description',
siteUrl: 'https://your.site.url',
},
plugins: [
{
resolve: `@committed/gatsby-theme-docs`,
options: {},
},
],
}
```
You might like to add the following scripts to your `package.json`:
```
"scripts": {
"clean": "gatsby clean",
"start": "gatsby develop",
"build": "gatsby build"
}
```
Put your markdown docs in `/docs/` and run:
```bash
gatsby develop
```
Visit `http://localhost:8000/` to view the site.
Full text search is provided, but you MUST clean first to reindex the content:
```bash
gatsby clean
# Then:
gatsby build
# Or
gatbsy develop
```
For full instructions see the [live demo](https://committed.software/theme).
## 🤖 SEO friendly
The docs come with SEO. Configure meta tags like title and description for each markdown file using MDX Frontmatter
```markup
---
title: "Title of the page"
description: "Description Tag for this page"
metaTitle: "Meta Title Tag for this page, but will default to title"
metaDescription: "Meta Description Tag for this page, but will default to description"
---
```
Canonical URLs are generated automatically.
## Development
We use workspaces to develop the theme alongside an example usage that also serves as a documentation site for this project.
On first use run
```bash
npm install
```
A standard set of support scripts are available throught the `package.json`.
We use semantic-release with [conventional commits](https://www.conventionalcommits.org).
Run `npm run commit` to help correctly form commit messages.
### Layout
A simplified layout is shown below
```shell
.
├── README.md
├── theme
│ ├── README.md
│ ├── gatsby-config.js
│ ├── gatsby-node.js
│ ├── index.js
│ └── package.json
│ └── src
├── example
│ ├── README.md
│ ├── gatsby-config.js
│ ├── package.json
│ └── docs
├── package.json
└── package-lock.json
```
### `theme`
The theme is defined by the `gatsby-config.js` file with the `gatsby-node.js` supplying the content from the site using the theme. The `src` folder contains the code for the theme, with the components used stored in the `theme/src/components` folder. Each markdown file is rendered using the `theme/src/layout/docs.tsx` to layout the supporting components and configure the markdown.
### `example`
This is an example usage of the theme. It looks the same as the
site of someone who installed and used your theme.
- `example/`
- `gatsby-config.js`: Specifies which theme to use and any other one-off config a site might need.
- `docs/`: The markdown documentation pages that make up the site.
You can run the example with:
```shell
npm run start
```
---
_Source: https://npm.io/package/@committed/gatsby-theme-docs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._