https://github.com/stacks-archive/sbtc-docs
Documentation about sBTC
https://github.com/stacks-archive/sbtc-docs
Last synced: about 2 months ago
JSON representation
Documentation about sBTC
- Host: GitHub
- URL: https://github.com/stacks-archive/sbtc-docs
- Owner: stacks-network
- License: mit
- Created: 2023-07-18T16:27:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T15:07:09.000Z (over 1 year ago)
- Last Synced: 2024-04-14T11:50:54.631Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://stacks-network.github.io/sbtc-docs/
- Size: 2.41 MB
- Stars: 11
- Watchers: 10
- Forks: 8
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# README
This is the documentation for sBTC. It is created with [mdbook](https://rust-lang.github.io/mdBook/index.html) and you can find a summary of the contents in [SUMMARY.md](./src/SUMMARY.md).
To serve the documentation locally, please [install mdbook](https://rust-lang.github.io/mdBook/guide/installation.html).
To be able to render [Mermaid] charts you will also need to install the [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) preprocessor.
This repo also uses Github actions to automatically deploy to [Github pages](https://stacks-network.github.io/sbtc-docs/) on every commit