mdbook-typst

mdbook-typst is a backend 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:

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

Next, install mdbook-typst (this project):

cargo install mdbook-typst

Then, add an entry to your book.toml:

[output.typst]

Finally, build your book via mdBook:

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:

[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 for a complete list of options.

If you want more control, consider creating your own formatter and/or preprocessing the book using the pullup project.

No default styling

[output.typst.style]
enable = false

will remove all the styling

Parts and Headings as natural header level = , ==, ===, ...

[output.typst.style]
simple = true

will make the Parts of the mdbook as first heading =

You can custom with set and show rules what you want.

The best is to add another file as a template with your custom style. You can regenerate your main content and keep all you styling in a seperate file.

See Making a Template - Separate File for more information

Template support.

in your book.toml:

[output.typst.template]
enable = true
name = "myTempalte.typ"
arg = '''
  title: [Dear Title],
  author: "Your Author name",
  dedication: [To you my friend\
              and you],
  publishing-info: [
    copyright blablabla]
'''

Note: the function in your myTemplate.typ file should be named template.

You may have your own TOC in your template. you will need

[output.typst.toc]
enable = false

To removove the default toc

Run a local version temporarly of this project

For release

Clone the repo and then cargo build --release

export PATH=$(pwd)/target/release:$PATH

will Override the Global mdbook-typst Command Temporarily in your current terminal window.

For debugging

Another way to build for debugging is cargo build

The path is then

export PATH=$(pwd)/target/debug:$PATH

But this is not fit for production.

Run a version globally and permanently on your machine

cargo install --path .