mirror of
https://github.com/leptos-rs/leptos
synced 2024-11-10 06:44:17 +00:00
docs: publish book during CI (#817)
This commit is contained in:
parent
5d3a360456
commit
4c1c12734a
2 changed files with 38 additions and 0 deletions
37
.github/workflows/publish-book.yml
vendored
Normal file
37
.github/workflows/publish-book.yml
vendored
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
name: Deploy book
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
paths: ['docs/book/**']
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # To push a branch
|
||||||
|
pull-requests: write # To create a PR from that branch
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Install mdbook
|
||||||
|
run: |
|
||||||
|
mkdir mdbook
|
||||||
|
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.27/mdbook-v0.4.27-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
|
||||||
|
echo `pwd`/mdbook >> $GITHUB_PATH
|
||||||
|
- name: Deploy GitHub Pages
|
||||||
|
run: |
|
||||||
|
cd docs/book
|
||||||
|
mdbook build
|
||||||
|
git worktree add gh-pages
|
||||||
|
git config user.name "Deploy book from CI"
|
||||||
|
git config user.email ""
|
||||||
|
cd gh-pages
|
||||||
|
# Delete the ref to avoid keeping history.
|
||||||
|
git update-ref -d refs/heads/gh-pages
|
||||||
|
rm -rf *
|
||||||
|
mv ../book/* .
|
||||||
|
git add .
|
||||||
|
git commit -m "Deploy book $GITHUB_SHA to gh-pages"
|
||||||
|
git push --force --set-upstream origin gh-pages
|
|
@ -59,6 +59,7 @@ Leptos is a full-stack, isomorphic Rust web framework leveraging fine-grained re
|
||||||
|
|
||||||
Here are some resources for learning more about Leptos:
|
Here are some resources for learning more about Leptos:
|
||||||
|
|
||||||
|
- [Book (work in progress)](https://leptos-rs.github.io/leptos/)
|
||||||
- [Examples](https://github.com/leptos-rs/leptos/tree/main/examples)
|
- [Examples](https://github.com/leptos-rs/leptos/tree/main/examples)
|
||||||
- [API Documentation](https://docs.rs/leptos/latest/leptos/)
|
- [API Documentation](https://docs.rs/leptos/latest/leptos/)
|
||||||
- [Common Bugs](https://github.com/leptos-rs/leptos/tree/main/docs/COMMON_BUGS.md) (and how to fix them!)
|
- [Common Bugs](https://github.com/leptos-rs/leptos/tree/main/docs/COMMON_BUGS.md) (and how to fix them!)
|
||||||
|
|
Loading…
Reference in a new issue