solana/docs
Michael Vines 07e8e8af38
Remove trailing whitespace (#10554)
automerge
2020-06-13 14:48:27 -07:00
..
art Cleanup programming model doc (#10274) 2020-05-27 16:18:11 -06:00
src Remove trailing whitespace (#10554) 2020-06-13 14:48:27 -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 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 Throw error if no release version (#10396) 2020-06-03 12:08:32 -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