solana/docs
Jack May eb1acaf927
Remove archiver and storage program (#9992)
automerge
2020-05-14 18:22:47 -07:00
..
art Add retransmit_stage diagram (#8645) 2020-03-05 10:12:02 -08:00
src Remove archiver and storage program (#9992) 2020-05-14 18:22:47 -07:00
theme
.gitattributes
README.md fix docs makefile (#10016) 2020-05-13 09:08:25 -07:00
book.toml Add mdbook-linkcheck to docker (#9123) 2020-03-27 10:18:01 -07:00
build-cli-usage.sh Pacify shellcheck 2020-04-15 17:46:19 -07:00
build.sh Align ci/publish-docs and ci/test-checks doc builds (#9653) 2020-04-22 09:51:01 -07:00
makefile fix docs makefile (#10016) 2020-05-13 09:08:25 -07:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00
set-solana-release-tag.sh Update set-solana-release-tag.sh 2020-04-03 11:21:34 -06:00

README.md

Building the Solana Docs

Install dependencies, build, and test the docs:

$ brew install coreutils
$ brew install mscgen
$ cargo install svgbob_cli
$ cargo install mdbook-linkcheck
$ cargo 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