Skip to content

Commit

Permalink
chore: release 0.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
MR-Addict committed Jan 14, 2024
1 parent e25c9ec commit 9330468
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 16 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ jobs:
name: ${{ matrix.target }}
path: target/release/mdbook-embedify.exe

- name: Publish crate
if: matrix.target == 'x86_64-unknown-linux-gnu'
uses: katyo/publish-crates@v2
with:
registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

release:
runs-on: ubuntu-latest
needs: build
Expand Down
6 changes: 3 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mdbook-embedify"
version = "0.2.1"
version = "0.2.2"
edition = "2021"
license = "MIT"
readme = "README.md"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can install it from crates.io using cargo.
cargo install mdbook-embedify
```

Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page. But it only supports **Linux** and **Windows**, if you are using **MacOS**, you have to install it from crates.io.
Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page.

After installation, add the following code to your `book.toml` file:

Expand Down
4 changes: 2 additions & 2 deletions example/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ copy-js = true
scroll-to-top.enable = true

announcement-banner.enable = true
announcement-banner.name = "0.2.1"
announcement-banner.name = "0.2.2"
announcement-banner.style = "default"
announcement-banner.message = "*Version **0.2.1** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.1).*"
announcement-banner.message = "*Version **0.2.2** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.2).*"
10 changes: 5 additions & 5 deletions example/src/global-configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Global Configuration

Some apps allow you to automatically add to every chapter. You can do this by adding `app-name = true` to embedify preprocessor in `book.toml` file to enable it.
Some apps allow you to automatically add to every chapter. You can do this by modifying `book.toml` file to enable them.

For example:

Expand All @@ -13,20 +13,20 @@ scroll-to-top.enable = true

> 💥Attention
>
> When you do this, you don't need to add `{% embed scroll-to-top %}` manually. It will be automatically added it to every chapter. Otherwise, it will be rendered twice.
> When you do this, you don't need to add `{% embed scroll-to-top %}` manually. It will be automatically added it to every chapter. If you do, it will be rendered twice.
<!-- embed ignore end -->

Below is a full list of apps that support this feature:
Below is a full list of apps that support global configuration:

```toml
[preprocessor.embedify]
scroll-to-top.enable = true

announcement-banner.enable = true
announcement-banner.name = "0.2.1"
announcement-banner.name = "0.2.2"
announcement-banner.style = "default"
announcement-banner.message = "*Version **0.2.1** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.1).*"
announcement-banner.message = "*Version **0.2.2** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.2).*"
```

You can see more details about each app at its own page.
6 changes: 3 additions & 3 deletions example/src/local/announcement-banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<!-- embed ignore begin -->

```text
{% embed announcement-banner name="0.2.1" style="default" message="*Version **0.2.1** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.1).*" %}
{% embed announcement-banner name="0.2.2" style="default" message="*Version **0.2.2** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.2).*" %}
```

<!-- embed ignore end -->
Expand All @@ -23,9 +23,9 @@ However, you may want to enable it for the whole book. You can do this by adding
```toml
[preprocessor.embedify]
announcement-banner.enable = true
announcement-banner.name = "0.2.1"
announcement-banner.name = "0.2.2"
announcement-banner.style = "default"
announcement-banner.message = "*Version **0.2.1** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.1).*"
announcement-banner.message = "*Version **0.2.2** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.2).*"
```

Note that announcement banner name must be **unique**, otherwise it won't be shown if there is another announcement banner with the same name when user closed it.
2 changes: 1 addition & 1 deletion example/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can install it from crates.io using cargo.
cargo install mdbook-embedify
```

Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page. But it only supports **Linux** and **Windows**, if you are using **MacOS**, you have to install it from crates.io.
Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page.

After installation, add the following code to your `book.toml` file:

Expand Down

0 comments on commit 9330468

Please sign in to comment.