BoltRing Documentation

Source code for BoltRing documentation static site

Introduction

This repository hosts the markdown based documentation and mkdocs based static site builder for https://docs.bolt-ring.com.

Development

Requirements

• Python 3.7 or higher for static site building and publishing.
• Poetry for installation and dependency management.

Installation

git clone https://github.com/bitcoin-ring/boltring-docs.git
cd boltring-docs
poetry install

Running

To start the developmnet server run:

mkdocs serve

Tasks

Before committing any changes you should run all formatting tasks with

poe all

Publishing

To publish the latest version the site run:

mkdocs gh-deploy