Skip to content

Commit

Permalink
chore: release 0.2.3
Browse files Browse the repository at this point in the history
  • Loading branch information
MR-Addict committed Jan 15, 2024
1 parent 9494819 commit 1d66e07
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 11 deletions.
2 changes: 1 addition & 1 deletion 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.2"
version = "0.2.3"
edition = "2021"
license = "MIT"
readme = "README.md"
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ cargo install mdbook-embedify

Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page.

Then you can check your installation by running:

```sh
mdbook-embedify --version
```

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

```toml
Expand Down
4 changes: 2 additions & 2 deletions example/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ command = "target/release/mdbook-embedify.exe"
scroll-to-top.enable = true

announcement-banner.enable = true
announcement-banner.id = "0.2.2"
announcement-banner.id = "0.2.3"
announcement-banner.theme = "default"
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).*"
announcement-banner.message = "*Version **0.2.3** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.3).*"
4 changes: 2 additions & 2 deletions example/src/global-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Below is a full list of apps that support global configuration:
scroll-to-top.enable = true

announcement-banner.enable = true
announcement-banner.id = "0.2.2"
announcement-banner.id = "0.2.3"
announcement-banner.theme = "default"
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).*"
announcement-banner.message = "*Version **0.2.3** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.3).*"
```

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 id="0.2.2" theme="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 announcement-banner id="0.2.3" theme="default" message="*Version **0.2.3** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.3).*" %}
```

<!-- 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.id = "0.2.2"
announcement-banner.id = "0.2.3"
announcement-banner.theme = "default"
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).*"
announcement-banner.message = "*Version **0.2.3** now has relased, check it out [here](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.3).*"
```

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.
8 changes: 7 additions & 1 deletion example/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ cargo install mdbook-embedify

Or you can download the binary from [releases](https://github.com/mr-addict/mdbook-embedify/releases) page.

Then you can check your installation by running:

```sh
mdbook-embedify --version
```

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

```toml
Expand Down Expand Up @@ -38,4 +44,4 @@ For example:

<!-- embed ignore end -->

You can see some examples at examples section.
You can see some examples at apps section.
3 changes: 2 additions & 1 deletion src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@ pub fn get_config_bool(config: &Config, key: &str, default: bool) -> bool {
pub fn reply_supports(pre: &dyn Preprocessor) {
// Handle support for the --supports command line argument
let matches = Command::new("mdbook-embedify")
.about("A mdbook embed preprocessor")
.about("A mdbook embed preprocessor that embeds app to your book")
.version(env!("CARGO_PKG_VERSION"))
.subcommand(
Command::new("supports")
.arg(Arg::new("renderer").required(true))
Expand Down

0 comments on commit 1d66e07

Please sign in to comment.