Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,16 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v5

- uses: dtolnay/rust-toolchain@v1
with:
toolchain: nightly
components: rust-docs

- uses: jontze/action-mdbook@v2
- uses: jontze/action-mdbook@v4
with:
token: ${{secrets.GITHUB_TOKEN}}
use-mermaid: true

- name: Check for broken links
run: |
Expand All @@ -38,7 +37,7 @@ jobs:

- name: Deploy
if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
uses: appleboy/scp-action@v0.1.7
uses: appleboy/scp-action@v1
with:
host: docs.espressif.com
username: ${{ secrets.PRODUCTION_USERNAME }}
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This repository contains the source of "The Rust on ESP" book.

## Quickstart

This book is generated using [`mdbook`] and additionally uses the [`mdbook-mermaid`] preprocessor to add support for diagrams. To install these tools:
This book is generated using [`mdbook`], which can be installed using Cargo:

```shell
cargo install mdbook mdbook-mermaid
cargo install mdbook
```

With `mdbook` and `mdbook-mermaid` installed, you can clone the repository and start a development server by running:
With `mdbook` installed, you can clone the repository and start a development server by running:

```shell
git clone https://github.com/esp-rs/book
Expand All @@ -19,7 +19,6 @@ mdbook serve
```

[`mdbook`]: https://github.com/rust-lang/mdBook
[`mdbook-mermaid`]: https://github.com/badboy/mdbook-mermaid

## License

Expand Down
1 change: 0 additions & 1 deletion assets/mermaid-init.js

This file was deleted.

1,282 changes: 0 additions & 1,282 deletions assets/mermaid.min.js

This file was deleted.

Loading