# Mdbook Embedify
 
This is a [mdbook](https://rust-lang.github.io/mdBook) preprocessor plugin that allows you to embed apps to your book, like youtube, codepen, giscus and many other apps.
> Attention 💥
>
> If you still using mdbook version below **v0.5.x**, please use **v0.2.x** of this plugin.
>
> This plugin requires mdbook version **v0.5.x** or above.
## 1. Installation
There are two ways to install this plugin.
You can install it from crates.io using cargo.
```sh
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
[preprocessor.embedify]
```
## 2. Usage
Then you can use `embed` macro to embed an app. The syntax is like this:
```text
{% embed app options[] %}
```
**options** are key-value based array seperated by space and its value should be wrapped by **quotes**. For example:
```text
{% embed codepen user="MR-Addict" slug="NWBOqKw" height="600" theme="dark" loading="lazy" %}
```
## 3. Examples
You can see a live demo and more detailed documentation [here](https://mr-addict.github.io/mdbook-embedify).
## 4. Development
Please read the [development guide](https://mr-addict.github.io/mdbook-embedify/development/index.html) for more information on how to contribute to this project.
- [Testing Guide](https://mr-addict.github.io/mdbook-embedify/development/testing.html) - Learn how to write and run tests
- [Template System](https://mr-addict.github.io/mdbook-embedify/development/template.html) - Create custom embed applications
- [Language Matching](https://mr-addict.github.io/mdbook-embedify/development/language-matching.html) - Understand file language detection
