mdbook-langtabs 0.2.0

An mdbook preprocessor that adds language tabs for code blocks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# mdbook-langtabs

[![Crates.io](https://img.shields.io/crates/v/mdbook-langtabs.svg)](https://crates.io/crates/mdbook-langtabs)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

An [mdBook](https://github.com/rust-lang/mdBook) preprocessor that creates language tabs for code examples.

![Language tabs example demo](https://raw.githubusercontent.com/nx10/mdbook-langtabs/refs/heads/main/demo.gif)

Also check out the [live demo](https://nx10.github.io/mdbook-langtabs/).

## Features

- Switch between language examples without scrolling
- Automatic language icons via [Devicon](https://devicon.dev/)

## Installation

```bash
cargo install mdbook-langtabs
```

Or install the current development version:

```bash
cargo install --git https://github.com/nx10/mdbook-langtabs
```

## Setup

Either use the automatic installer:

```bash
mdbook-langtabs install /path/to/your/book
```

Or manually:

1. Add to your `book.toml`:

```toml
[preprocessor.langtabs]
command = "mdbook-langtabs"

[output.html]
additional-css = ["langtabs.css"]
additional-js = ["langtabs.js"]
```

2. Copy `langtabs.css` and `langtabs.js` to your book's root directory.

## Usage

Wrap your code blocks with the special comments:

````markdown
<!-- langtabs-start -->
```rust
fn main() {
    println!("Hello from Rust!");
}
```

```python
def main():
    print("Hello from Python!")
```

```javascript
function main() {
    console.log("Hello from JavaScript!");
}
```
<!-- langtabs-end -->
````

This creates tabbed code examples that readers can switch between, as shown in the demo above.

## License

MIT