README.md

bitpaper-api-docs

Static docs for the Bitpaper REST API.

Setup

npm run dev

Local development runs at http://localhost:3007. Override the port with PORT=3017 npm run dev.

Authoring

It's just a single file: index.html.

1. Read the contribution guide
2. Edit index.html accordingly
3. Push or merge to the default branch

Changes deploy automatically to developers.bitpaper.io.

Test

npm test

Lint

Deployments also trigger lint.yml, essentially vale.sh prose checks.

Structure

├── index.html   # documentation page
├── app.js       # entry point
├── assets/      # static files
├── lib/
│   └── server/  # HTTP server module
└── test/        # smoke tests

Initial structure borrowed from Slate.

MIT - Bitpaper LTD