gatsby-openrpc-theme/README.md

A gatsby theme for generated OpenRPC documentation

# gatsby-openrpc-theme


## Usage


1. Install:

```
npm install @xops.net/gatsby-openrpc-theme
```

2. Add as a plugin to your Gatsby config:

`gatsby-config.js`

```javascript
  //...
  plugins: [
    "@xops.net/gatsby-openrpc-theme"
  ],
  //...
```

3. Add markdown files to `src/docs`

`src/docs`:

```
src
├── docs
│   ├── page-3.md
│   ├── page-4.md
│   └── page-5.md
```

OR

4. Add tsx files to `src/pages`
```
src
├── pages
│   ├── index.tsx
```

### Contributing

How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), . Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.