solana/docs
Greg Fitzgerald bfca226964
Hoist USB URL docs (#8894)
2020-03-16 17:07:39 -06:00
..
art Add retransmit_stage diagram (#8645) 2020-03-05 10:12:02 -08:00
src Hoist USB URL docs (#8894) 2020-03-16 17:07:39 -06: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 Don't tell users to install unreleased software versions 2020-03-12 10:01: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 source markdown in CI 2020-03-12 14:34:28 -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