solana/docs/README.md

31 lines
366 B
Markdown

Building the Solana Docs
---
Install dependencies, build, and test the docs:
```bash
$ brew install coreutils
$ cargo install svgbob_cli
$ brew install mscgen
$ brew install mdbook
$ ./build.sh
```
Run any Rust tests in the markdown:
```bash
$ make test
```
Render markdown as HTML:
```bash
$ make build
```
Render and view the docs:
```bash
$ make open
```