solana/docs
Dan Albert c52f06a54a
Fix plumtree link (#10755)
Co-authored-by: publish-docs.sh <maintainers@solana.com>
2020-06-23 23:35:35 +00:00
..
art Cleanup programming model doc (#10274) 2020-05-27 16:18:11 -06:00
src Fix plumtree link (#10755) 2020-06-23 23:35:35 +00:00
theme
.gitattributes
README.md fix docs makefile (#10016) 2020-05-13 09:08:25 -07:00
book.toml Add crates.io to exclude... (#10640) 2020-06-17 09:10:30 +09: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
set-solana-release-tag.sh Don't bother `api.github.com` on pull requests to avoid getting rate limited 2020-06-18 23:48:31 +00: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