30
docs/README.md
Normal file
30
docs/README.md
Normal file
@ -0,0 +1,30 @@
|
||||
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
|
||||
```
|
Reference in New Issue
Block a user