Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add rustdoc hint #764

Merged
merged 2 commits into from
Jun 29, 2022
Merged

docs: add rustdoc hint #764

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4826bc
Update README.md
TriplEight Jun 21, 2022
24aef93
Merge pull request #1 from TriplEight/TriplEight-rust-hints
TriplEight Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
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