Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.4 KB

README.md

File metadata and controls

53 lines (32 loc) · 1.4 KB

Mdbook Embedify

Crates.io Crates.io

This is a mdbook preprocessor plugin that allows you to embed apps to your book, like youtube, codepen and some other apps.

1. Installation

There are two ways to install this plugin.

You can install it from crates.io using cargo.

cargo install mdbook-embedify

Or you can download the binary from releases page.

Then you can check your installation by running:

mdbook-embedify --version

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

[preprocessor.embedify]

2. Usage

Then you can use embed macro to embed an app. The syntax is like this:

{% embed app options[] %}

options are key-value based array seperated by space and its value must be wrapped by quotes. For example:

{% embed codepen user="MR-Addict" slug="NWBOqKw" height="600" theme="dark" loading="lazy" %}

3. Examples

preview

You can see a live demo and more detailed documentation here.

4. More Apps

If you want to add more apps to this preprocessor, you can follow the instructions here.