Skip to content

Commit 3bbd450

Browse files
committed
fix: update README and documentation examples for consistency and clarity
1 parent 510cfba commit 3bbd450

5 files changed

Lines changed: 9 additions & 8 deletions

File tree

.github/workflows/page.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
run: cargo test --all-features --verbose
2525

2626
- name: Build book
27-
run: head -n 11 README.md > docs/src/index.md && mdbook build docs
27+
run: head -n 9 README.md > docs/src/index.md && mdbook build docs
2828

2929
- name: Deploy to github pages
3030
uses: crazy-max/ghaction-github-pages@v4

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ This is a [mdbook](https://rust-lang.github.io/mdBook) preprocessor plugin that
66

77
> Attention 💥
88
>
9-
> If you still using mdbook version below **v0.5.x**, please use **v0.2.x** of this plugin.
10-
>
11-
> This plugin requires mdbook version **v0.5.x** or above.
9+
> Currently 0.3.x requires mdbook version **v0.5.x** or above, if you are using an older version of mdbook, please use **v0.2.x** of this plugin
1210
1311
## 1. Installation
1412

docs/src/global-embedding.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@ Some apps allow you to automatically embed to every chapter. You can do this by
44

55
For example:
66

7-
{% embed include file="book.toml" range="45-46" %}
7+
```toml
8+
[preprocessor.embedify]
9+
scroll-to-top.enable = true
10+
```
811

912
> Attention 💥
1013
>
1114
> When you do this, you don't need to add `{% embed-ignore scroll-to-top %}` manually. It will be automatically added it to every chapter. If you do, it will be rendered twice.
1215
1316
Below is a full list of apps that support global configuration:
1417

15-
{% embed include file="book.toml" range="45-63" %}
18+
{% embed include file="book.toml" range="43-63" %}
1619

1720
You can see more details about each app at its own page.

docs/src/local/announcement-banner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ This book's announcement banner is enabled, you can see it at the top of this pa
1919

2020
However, you may want to enable it for the whole book. You can do this by adding below options to `book.toml` file after `[preprocessor.embedify]` section:
2121

22-
{% embed include file="book.toml" range="51-53" %}
22+
{% embed include file="book.toml" range="49-51" %}
2323

2424
Note that announcement banner id must be **unique**, otherwise it won't be shown if there is another announcement banner with the same id when user closed it.

docs/src/local/footer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This book's footer is enabled, you can see it at the bottom of this page.
1818

1919
However, you may want to enable it for the whole book. You can do this by adding below options to `book.toml` file after `[preprocessor.embedify]` section:
2020

21-
{% embed include file="book.toml" range="49-49" %}
21+
{% embed include file="book.toml" range="46-47" %}

0 commit comments

Comments
 (0)