mdbook-typst - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #android #linux #docker #macos #java #kubernetes #vue #awesome-list #pytorch

mdbook-typst

(★ 81)

An mdBook backend to output Typst markup, pdf, png, or svg

File Explorer

Download Latest Version (.zip)

- - release-plz.yaml
- config.rs
- converters.rs
- css.rs
- main.rs
.gitignore
Cargo.lock
Cargo.toml
CHANGELOG.md
LICENSE-MIT
README.md
release-plz.toml

# Installation Guide

1. Get the code

git clone https://github.com/LegNeato/mdbook-typst

Downloads the entire project code from GitHub to your computer.

cd mdbook-typst

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.

cargo install --git https://github.com/typst/typst

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install mdbook-typst

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo install --git https://github.com/typst/typst

Builds and installs the package published on crates.io — no need to clone the repo yourself.

cargo install mdbook-typst

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `mdbook-typst`

`mdbook-typst` is a
[backend](https://rust-lang.github.io/mdBook/for_developers/backends.html) for
[mdBook]. The backend converts the book to
[Typst] markup and can output any format Typst can (currently
`pdf`, `png`, `svg`, and raw Typst markup).

## Usage

First, install the Typst cli:

```sh
cargo install --git https://github.com/typst/typst
```

Next, install `mdbook-typst` (this project):

```sh
cargo install mdbook-typst
```

Then, add an entry to your
[book.toml]:

```toml
[output.typst]
```

Finally, build your book via mdBook:

```sh
mdbook build
```

By default `mdbook-typst` will output raw Typst markup to `book/typst/book.typst`.

## Pdf and other formats

Pdf and other formats can be output instead of raw Typst markup. In your [book.toml] set the `format` value of the `output` config section:

```toml
[output.typst.output]
format = "pdf"
```

By default `mdbook-typst` will output to `book/typst/book.[format]`.

## Other configuration

`mdbook-typst` is fairly configurable. Check out [the configuration
code](./src/config.rs) for a complete list of options.

If you want more control, consider creating your own formatter and/or preprocessing the
book using the [pullup](https://github.com/LegNeato/pullup) project.

[mdBook]: https://github.com/rust-lang/mdBook
[book.toml]: https://rust-lang.github.io/mdBook/guide/creating.html#booktoml
[Typst]: https://typst.app/docs/