Move markdown book out of src/

This commit is contained in:
Greg Fitzgerald 2018-11-26 09:12:22 -07:00 committed by Grimes
parent a13e25f083
commit 88e270723f
40 changed files with 18 additions and 12 deletions

2
.gitignore vendored
View File

@ -1,5 +1,5 @@
/target/
/book/
/book/html/
**/*.rs.bk
.cargo

View File

@ -73,19 +73,19 @@ cargo install mdbook
Run any Rust tests in the markdown:
```bash
mdbook test
mdbook test book
```
Render markdown as HTML:
```bash
mdbook build
mdbook build book
```
Render and view the book:
```bash
mdbook build --open
mdbook build --open book
```

View File

@ -1,2 +0,0 @@
[book]
title = "Solana: Blockchain Rebuilt for Scale"

8
book/book.toml Normal file
View File

@ -0,0 +1,8 @@
[book]
title = "Solana: Blockchain Rebuilt for Scale"
[build]
build-dir = "html"
create-missing = false
[output.html]

View File

Before

Width:  |  Height:  |  Size: 9.3 KiB

After

Width:  |  Height:  |  Size: 9.3 KiB

View File

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

View File

Before

Width:  |  Height:  |  Size: 4.8 KiB

After

Width:  |  Height:  |  Size: 4.8 KiB

View File

Before

Width:  |  Height:  |  Size: 6.2 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

View File

Before

Width:  |  Height:  |  Size: 8.0 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

View File

Before

Width:  |  Height:  |  Size: 8.1 KiB

After

Width:  |  Height:  |  Size: 8.1 KiB

View File

@ -22,13 +22,13 @@ maybe_install() {
export PATH=$CARGO_HOME/bin:$PATH
maybe_install mdbook
_ mdbook test
_ mdbook build
_ mdbook test book
_ mdbook build book
echo --- create book repo
(
set -x
cd book/
cd book/html/
git init .
git config user.email "maintainers@solana.com"
git config user.name "$(basename "$0")"
@ -40,7 +40,7 @@ echo --- publish
if [[ $BUILDKITE_BRANCH = master ]]; then
(
set -x
cd book/
cd book/html/
git remote add origin git@github.com:solana-labs/solana.git
git push -f origin HEAD:gh-pages
)

View File

@ -47,8 +47,8 @@ done
# Build the HTML
export PATH=$CARGO_HOME/bin:$PATH
maybe_install mdbook
_ mdbook test
_ mdbook build
_ mdbook test book
_ mdbook build book
echo --- ci/localnet-sanity.sh
(