Mdbook Embedify

This is a mdbook preprocessor plugin that allows you embed apps to your book, like youtube, codepen and some other apps. If you find any problems while using it or have any other suggestions, welcmoe to open an issue.

1. Installation

First, you need to install mdbook-embedify to your computer. You can install it from crates.io using cargo.

cargo install mdbook-embedify

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" %}

Below is the full list of supported apps and their options(* means required):

3. Examples

{% embed gist id="76cf171d1bdd7da41d4ca96b908eb57a" %}

{% embed youtube id="EngW7tLk6R8" %}

{% embed bilibili id="BV1uT4y1P7CX" danmaku="0" %}

{% embed codesandbox id="ke8wx" theme="dark" %}

{% embed stackblitz id="vitejs-vite-y8mdxg" theme="dark" %}

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