solana/docs
Michael Vines cffd8d9427 Add missing " 2020-06-08 17:44:05 -07:00
..
art
src Add missing " 2020-06-08 17:44:05 -07:00
theme
.gitattributes
README.md
book.toml
build-cli-usage.sh
build.sh
makefile
offline-cmd-md-links.sh
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