# shamin-gatsby-theme

> Create beautiful api documentation with gatsby and greenboard

Latest version **0.1.8** (published 2019-10-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install shamin-gatsby-theme
pnpm add shamin-gatsby-theme
yarn add shamin-gatsby-theme
bun add shamin-gatsby-theme
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2019-10-28 |
| First published | 2019-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 40.1 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 250 |
| Maintainers | shamin.meerankutty |

## Links

- npm: https://www.npmjs.com/package/shamin-gatsby-theme
- Repository: https://github.com/shamin/greenboard
- Homepage: https://github.com/shamin/greenboard#readme
- Issues: https://github.com/shamin/greenboard/issues
- npm.io page: https://npm.io/package/shamin-gatsby-theme

## Dependencies (10)

- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [js-search](https://npm.io/package/js-search.md) ^1.4.3
- [node-sass](https://npm.io/package/node-sass.md) ^4.12.0
- [react-helmet](https://npm.io/package/react-helmet.md) ^5.2.1
- [rehype-react](https://npm.io/package/rehype-react.md) ^4.0.1
- [gatsby-plugin-sass](https://npm.io/package/gatsby-plugin-sass.md) ^2.1.17
- [prism-react-renderer](https://npm.io/package/prism-react-renderer.md) ^1.0.1
- [gatsby-source-filesystem](https://npm.io/package/gatsby-source-filesystem.md) ^2.1.28
- [gatsby-transformer-remark](https://npm.io/package/gatsby-transformer-remark.md) ^2.6.26
- [gatsby-plugin-react-helmet](https://npm.io/package/gatsby-plugin-react-helmet.md) ^3.1.11

## Recent versions

- 0.1.8 (latest) — 2019-10-28
- 0.1.2 — 2019-10-28
- 0.1.1 — 2019-10-28
- 0.1.0 — 2019-10-28

## README

# Greenboard

Create beautiful api documentation with gatsby and greenboard

## Installation

Setup your folder and install gatsby, react and react-dom
```shell
mkdir my-docs
cd my-docs
yarn init

yarn add gatsby react react-dom
```

Install greenboard
```shell
yarn add greenboard
```


Then add `greenboard` to your `gatsby-config.js`. 

```javascript
module.exports = {
  plugins: [
    {
      resolve: "greenboard",
      options: {},
    },
  ],
}
```

That's it, you can now run your gatsby site using

```shell
yarn gatsby develop
```

Build the production files

```shell
yarn gatsby build
```

---
_Source: https://npm.io/package/shamin-gatsby-theme · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._