solana/docs
Greg Fitzgerald 2534a028c0
Move docs to imperative mood (#8643)
* Move docs to imperative tone

* Apply review feedback
2020-03-04 17:42:22 -07:00
..
art Update TVU drawing (#8611) 2020-03-04 15:16:35 -08:00
src Move docs to imperative mood (#8643) 2020-03-04 17:42:22 -07:00
theme Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
.gitattributes Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
README.md Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
book.toml Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
build-cli-usage.sh Prevent trailing space in CLI usage docs generation (#8578) 2020-03-02 16:37:38 -08:00
build.sh Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
makefile Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00

README.md

Building the Solana Docs

Install dependencies, build, and test the docs:

$ brew install coreutils
$ cargo install svgbob_cli
$ brew install mscgen
$ brew install mdbook
$ ./build.sh

Run any Rust tests in the markdown:

$ make test

Render markdown as HTML:

$ make build

Render and view the docs:

$ make open