solana/docs
Michael Vines d7fa40087c
Bump version to 1.2.0
2020-03-28 09:44:13 -07:00
..
art
src Bump version to 1.2.0 2020-03-28 09:44:13 -07:00
theme
.gitattributes
README.md
book.toml Add mdbook-linkcheck to docker (#9123) 2020-03-27 10:18:01 -07:00
build-cli-usage.sh
build.sh
makefile
offline-cmd-md-links.sh
set-solana-release-tag.sh

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