bf1942/actions-gh-pages
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add rustdoc hint (#764)

Browse Source
This commit is contained in:
Denis Pisarev
2022-06-29 13:16:59 +02:00
committed by GitHub
parent 1304921c60
commit 97637bffb0
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -240,6 +240,7 @@ The default is `gh-pages`.
### ⭐️ Source Directory `publish_dir`
A source directory to deploy to GitHub Pages. The default is `public`.
Only the contents of this dir are pushed to GitHub Pages branch, `gh-pages` by default.
```yaml
- name: Deploy
@@ -1035,6 +1036,10 @@ jobs:
publish_dir: ./book
```
Hint: you may want to publish your rustdocs. And use relative links to it from the md docs, and have them checked by `mdbook`.
Then, according to the [doc](https://rust-lang.github.io/mdBook/guide/creating.html#source-files), you may put `./target/doc/`
to your `./book/src` dir before you `mdbook build` and then it will end up in `./book/html/` and in your Github Pages.
### ⭐️ Flutter Web
An example workflow for [Flutter web project].