mdbook-iced

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #machine-learning #deep-learning #docker #awesome #cli #kubernetes #security #pytorch #ios

(★ 24)

An mdBook preprocessor to turn iced code blocks into interactive examples

mdbook-iced 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mdbook-iced

[![Documentation](https://docs.rs/mdbook-iced/badge.svg)](https://docs.rs/mdbook-iced)
[![Crates.io](https://img.shields.io/crates/v/mdbook-iced.svg)](https://crates.io/crates/mdbook-iced)
[![License](https://img.shields.io/crates/l/mdbook-iced.svg)](https://github.com/iced-rs/mdbook-iced/blob/master/LICENSE)
[![Downloads](https://img.shields.io/crates/d/mdbook-iced.svg)](https://crates.io/crates/mdbook-iced)
[![Test Status](https://img.shields.io/github/actions/workflow/status/iced-rs/mdbook-iced/test.yml?branch=master&event=push&label=test)](https://github.com/iced-rs/mdbook-iced/actions)
[![Discourse](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fdiscourse.iced.rs%2Fsite%2Fstatistics.json&query=%24.users_count&suffix=%20users&label=discourse&color=5e7ce2)](https://discourse.iced.rs/)
[![Discord Server](https://img.shields.io/discord/628993209984614400?label=&labelColor=6A7EC2&logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/3xZJ65GAhd)

An mdBook preprocessor to turn [iced] code blocks into interactive examples.

</div>

## Overview
This is a simple mdBook preprocessor that can add a play button to any [iced] code block.

Pressing the play button loads and embeds the resulting Wasm application in a fully interactive `<canvas>` right under the code block.

It is compatible with any code block that features a `main` function where an [iced] program is run—even if it is hidden! This means
it can be used to create interactive examples even for books completely unrelated to [iced].

Currently, this preprocessor is mainly being used in [the official guide] to [iced]. Check it out!

## Installation
Install the `mdbook-iced` preprocessor and the [`wasm-bindgen-cli`] tool with `cargo install`:

```
cargo install mdbook-iced wasm-bindgen-cli
```

Also, make sure your toolchain has the `wasm32-unknown-unknown` target:

```
rustup target add wasm32-unknown-unknown
```

## Usage
Add a `[preprocessor.iced]` entry to your `book.toml` and specify the revision of `iced` your book will use:

```toml
[preprocessor.iced]
# You can use a commit hash
rev = "9db6ac8f202ebdc1453edee01da0b30aee0949d8"
# ... a branch
branch = "master"
# ... or a tag!
tag = "0.13.0" # Not yet released!
```

Then, simply add an `iced` label to any executable code block you want to make playable. For instance, the
classical counter:

````markdown
# A cool example

This is an mdBook and here is an iced counter:

```rust,ignore,iced
use iced::widget::{button, column, text, Column};

pub fn main() -> iced::Result {
    iced::run("A counter", update, view)
}

#[derive(Debug, Clone)]
enum Message {
    Increment,
}

fn update(value: &mut u64, message: Message) {
    match message {
        Message::Increment => *value += 1,
    }
}

fn view(value: &u64) -> Column<Message> {
    column![
        text(value),
        button("+").on_press(Message::Increment),
    ]
}
```
````

Check out the [`book`](book) directory for a real mdBook example!

[iced]: https://github.com/iced-rs/iced
[`wasm-bindgen-cli`]: https://rustwasm.github.io/wasm-bindgen/reference/cli.html
[the official guide]: https://book.iced.rs/

mdbook-iced

mdbook-iced 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mdbook-iced

mdbook-iced 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README