Skip to content

Commit

Permalink
docs: add rustdoc hint (#764)
Browse files Browse the repository at this point in the history
  • Loading branch information
TriplEight committed Jun 29, 2022
1 parent 1304921 commit 97637bf
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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].
Expand Down

0 comments on commit 97637bf

Please sign in to comment.