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

Last update: Dec 16, 2023

Related tags

Overview

`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

Finally, add an entry to your book.toml:

[output.typst]

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.

Replace an app's icon from a png with a single terminal script. Made with Rust

Replace macOS App Icon Replace an app's icon from a png with a single terminal CLI. Made with Rust

8 Aug 3, 2022

PNG manipulation library.

pngmanip A simple rust library for parsing and manipulating PNG images, primarily at the chunk level. The intended use case was for solving PNG based

1 Jan 7, 2022

A little program written in Rust that prints random PNG images to the terminal in text grabbed from an image repo.

Cermic A little program written in Rust that prints random PNG images to the terminal in text grabbed from an image repo. NOTE: As of right now, Cermi

7 Oct 1, 2022

png_defringe_rs is a port of Immorpher's PNG Defringe program written in Rust to achieve easier installation and faster performance.

png_defringe_rs png_defringe_rs is a port of Immorpher's PNG Defringe program written in Rust to achieve easier installation and faster performance. U

2 Nov 17, 2022

SAORI for UKAGAKA. Convert a image file to resized png file.

Resized Png GitHub repository これは何? デスクトップマスコット、「伺か」で使用できるSAORIの一種です。機能としては、指定した画像ファイルを拡大または縮小し、pngとして出力します。「伺か」「SAORI」等の用語については詳しく説明いたしませんのでご了承下さい。

2 Jan 3, 2023

Rust low-level minimalist APNG writer and PNG reader with just a few dependencies with all possible formats coverage (including HDR).

project Wiki https://github.com/js29a/micro_png/wiki at glance use micro_png::*; fn main() { // load an image let image = read_png("tmp/test.

8 Aug 30, 2023

Turns lines of text into SVG files.

Sentences 2 svg Does what it says on the tin. This takes in a file with some sentences and outputs numbered svgs. There are 3 arguments to keep in min

1 Jan 1, 2022

ufo2nft is a CLI Rust tool to automate creating on-chain SVG NFTs from UFO font sources

ufo2nft is a CLI Rust program created by Eli Heuer at the 2022 Seattle Solana Hacker House event. It uses Norad to create on-chain SVG images from UFO font sources, and prepares them for minting as Solana NFTs. For Ethereum NFTs the program can just export the SVGs and Ethereum NFTs can be built manually.

1 Feb 10, 2022

Captcha based on SVG.

BioSvg Captcha based on SVG. Original idea SVG绘制原理与验证码 Usage cargo add biosvg let (answer, svg) = BiosvgBuilder::new() .length(4) .difficulty(

7 Aug 29, 2023

Comments

Tracking issue: Make the rust book perfect
The Rust book is a good litmus test. With the latest master, the following is generated:

book.pdf

Issues:

[ ] Codeblock fence name items like rust,ignore are only parsed as ignore. This is likely a pulldown_cmark issue.

[ ] Inter-doc links are not translated.

[ ] Filename in code examples is just sort of hanging in space.

[ ] Images are not included.

[ ] Notes and warnings and not displayed special.
opened by LegNeato 0

Releases(v0.1.1)

v0.1.1(Dec 1, 2023)
Bug Fixes

Support strong and emphasis embedded in other items.

Commit Statistics

2 commits contributed to the release.

1 commit was understood as conventional.

0 issues like '(#ID)' were seen in commit messages

Commit Details

view details

Uncategorized

Support strong and emphasis embedded in other items. (d32b0b1)

Fix description grammar. (523a016)

Source code(tar.gz)
Source code(zip)
v0.1.0(Dec 1, 2023)
Bug Fixes

Fix cargo-smart-release.

Commit Statistics

7 commits contributed to the release over the course of 1 calendar day.

1 commit was understood as conventional.

0 issues like '(#ID)' were seen in commit messages

Commit Details

view details

Uncategorized

Add description. (8db6a2d)

Release mdbook-typst v0.1.0 (d0d2d42)

Fix cargo-smart-release. (98227ce)

Add CHANGELOG. (8bc1a4c)

Exit and output stdout/stderr when typst call fails. (7d5b02e)

Update to new pullup (5bed32e)

Initial commit. (ea33313)

Source code(tar.gz)
Source code(zip)