Skip to content

Commit 97637bf

Browse files
authored
docs: add rustdoc hint (#764)
1 parent 1304921 commit 97637bf

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ The default is `gh-pages`.
240240
### ⭐️ Source Directory `publish_dir`
241241

242242
A source directory to deploy to GitHub Pages. The default is `public`.
243+
Only the contents of this dir are pushed to GitHub Pages branch, `gh-pages` by default.
243244

244245
```yaml
245246
- name: Deploy
@@ -1035,6 +1036,10 @@ jobs:
10351036
publish_dir: ./book
10361037
```
10371038

1039+
Hint: you may want to publish your rustdocs. And use relative links to it from the md docs, and have them checked by `mdbook`.
1040+
Then, according to the [doc](https://rust-lang.github.io/mdBook/guide/creating.html#source-files), you may put `./target/doc/`
1041+
to your `./book/src` dir before you `mdbook build` and then it will end up in `./book/html/` and in your Github Pages.
1042+
10381043
### ⭐️ Flutter Web
10391044

10401045
An example workflow for [Flutter web project].

0 commit comments

Comments
 (0)