solana/docs/README.md

32 lines
400 B
Markdown
Raw Normal View History

2020-02-25 14:41:14 -08:00
Building the Solana Docs
---
Install dependencies, build, and test the docs:
```bash
2020-02-25 14:41:14 -08:00
$ brew install coreutils
$ brew install mscgen
2020-05-13 09:08:25 -07:00
$ cargo install svgbob_cli
$ cargo install mdbook-linkcheck
$ cargo install mdbook
2018-12-14 15:55:16 -08:00
$ ./build.sh
```
Run any Rust tests in the markdown:
```bash
2018-12-14 15:55:16 -08:00
$ make test
```
Render markdown as HTML:
```bash
2018-12-14 15:55:16 -08:00
$ make build
```
Render and view the docs:
```bash
2018-12-14 15:55:16 -08:00
$ make open
```