Add comments to edit in case of custom book path

This commit is contained in:
kana 2021-07-04 18:27:53 +01:00 committed by GitHub
parent 27b1e05c87
commit 00473d8420
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -26,7 +26,7 @@ before_script:
- cargo install-update -a - cargo install-update -a
script: script:
- mdbook build && mdbook test - mdbook build && mdbook test # Edit in case of custom book path: mdbook build path/to/mybook && mdbook test path/to/mybook
``` ```
## Deploying Your Book to GitHub Pages ## Deploying Your Book to GitHub Pages
@ -50,7 +50,7 @@ deploy:
provider: pages provider: pages
skip-cleanup: true skip-cleanup: true
github-token: $GITHUB_TOKEN github-token: $GITHUB_TOKEN
local-dir: book local-dir: book # Edit in case of custom book path: path/to/mybook/book
keep-history: false keep-history: false
on: on:
branch: main branch: main
@ -77,7 +77,7 @@ before_script:
- cargo install-update -a - cargo install-update -a
script: script:
- mdbook build && mdbook test - mdbook build && mdbook test # Edit in case of custom book path: mdbook build path/to/mybook && mdbook test path/to/mybook
deploy: deploy:
provider: pages provider: pages
@ -85,7 +85,7 @@ deploy:
edge: true edge: true
cleanup: false cleanup: false
github-token: $GITHUB_TOKEN github-token: $GITHUB_TOKEN
local-dir: book local-dir: book # Edit in case of custom book path: path/to/mybook/book
keep-history: false keep-history: false
on: on:
branch: main branch: main