Skip to content

nx10/mdbook-langtabs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdbook-langtabs

Crates.io License: MIT

An mdBook preprocessor that creates language tabs for code examples.

Language tabs example demo

Also check out the live demo.

Features

  • Switch between language examples without scrolling
  • Automatic language icons via Devicon

Installation

cargo install mdbook-langtabs

Or install the current development version:

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

Setup

Either use the automatic installer:

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

Or manually:

  1. Add to your book.toml:
[preprocessor.langtabs]
command = "mdbook-langtabs"

[output.html]
additional-css = ["langtabs.css"]
additional-js = ["langtabs.js"]
  1. Copy langtabs.css and langtabs.js to your book's root directory.

Usage

Wrap your code blocks with the special comments:

<!-- 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

About

Language code tabs preprocessor for mdBook

Resources

Stars

Watchers

Forks

Packages

No packages published