Trunk

Plugin which bundles packages using Trunk and includes them as iframes.

Example

All examples are part of the book source code.

use leptos::prelude::*;

#[component]
pub fn Button() -> impl IntoView {
    let (count, set_count) = signal(0);

    view! {
        <button on:click=move |_| set_count.update(|count| *count += 1 )>
            "Count: " {count}
        </button>
    }
}

Installation

cargo install mdbook-trunk

Configuration

Add the preprocessor and renderer to book.toml. Note that the HTML renderer is also required.

[preprocessor.trunk]

[output.html]

[output.trunk]

Add the additional CSS and JS files to the book with the following command.

mdbook-trunk install

Add the additional CSS and JS files to the HTML renderer in book.toml.

[output.html]
additional-css = ["theme/trunk.css"]
additional-js = ["theme/trunk.js"]

Usage

Define a Trunk include as follows:

```toml,trunk
# Package to build, must be in the current workspace.
package = "book-example"

# Features to enable for the package.
features = ["button"]
```

The following options are available:

# Package to build, must be in the current workspace.
package = "book-example"

# Features to enable for the package.
features = ["button"]

# Sources files to render (optional).
# Relative to the package root.
files = ["src/button.rs"]

# Whether to show files by default (optional).
show_files = true

# URL query for the iframe URL (optional).
# The leading question mark is optional.
url_query = "?key=value"

# URL fragment for the iframe URL (optional).
# The leading hash is optional.
url_fragment = "#header"

# HTML attributes for the iframe (optional).
[attributes]
allow = "fullscreen"

# Replacements to apply on files (optional).
[[file_replacements]]
find = "Some sentence"
replace = "Another sentence"

Building

Build the book using mdbook build. This will output multiple directories in book/build.
Combine the build outputs using mdbook-trunk combine. This will combine the output directories in book/dist.
Serve the book/dist directory.