solana/docs
Justin Starry 021d0a46f8
Move docs from book/ to docs/ (#8469)
automerge
2020-02-26 07:11:38 -08:00
..
art Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08:00
src Move docs from book/ to docs/ (#8469) 2020-02-26 07:11:38 -08: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 Move docs from book/ to docs/ (#8469) 2020-02-26 07:11: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

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