Skip to content

Commit

Permalink
Add mdbook-admonish to gh deployment workflow (#7)
Browse files Browse the repository at this point in the history
* add mdbook-admonish to gh workflow

* update mdbook release to match mdbook-admonish

* Update README.md to include mdbook-admonish instructions
  • Loading branch information
diversable authored Dec 2, 2023
1 parent de844e9 commit e2eb0a8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/publish-book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ jobs:
- 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
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.35/mdbook-v0.4.35-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Install mdbook-admonish
run: |
cargo install mdbook-admonish --vers "1.14.0" --locked
mdbook-admonish install ./
- name: Deploy GitHub Pages
run: |
mdbook build
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,20 @@ This project contains the core of a new introductory guide to Leptos.

It is built using `mdbook`. You can view a local copy by installing `mdbook`

```bash
```sh
cargo install mdbook
```

and run the book with
This book also uses an mdbook preprocessor called `mdbook-admonish` to style blocks of text like notes, warnings, etc.

Install mdbook admonish using:

```sh
cargo install mdbook-admonish
```

and then run the book with
```sh
mdbook serve
```

Expand Down

0 comments on commit e2eb0a8

Please sign in to comment.