mdbook-arborium 0.1.0

A static mdbook preprocessor for arborium.
mdbook-arborium-0.1.0 is not a library.

mdbook-arborium

This integrates [arborium][https://arborium.bearcove.eu/] with mdbook.

Roadmap

  • Static mdbook preprocessor.
    • replaces the code blocs with the highlighted code using custom HTML tags.
    • Theme selector using js and css.
    • Only include part of the themes with the arguments of the install subcommand.
  • Add scrolling to the menu for selecting the theme.
  • Switch theme configuration to book.toml instead of arguments.
  • Expose some arborium config in the book.toml.
  • Support for custom tree-sitter grammars.

How the preprocessor works

The preprocessor searches for ```lang where lang is one of the languages supported by arborium and replaces them with the highlighted html. If lang isn't supported the codeblock is left as is.

So if any other plugins uses the same specifier as a grammar for the code it should be declared before mdbook-arborium.

For the preprocessor to work you have to run the install subcommand that will generate the necessary js and css files. Then you register them in the book.toml file like so:

[output.html]
additional-js = ["./mdbook-code-theme/code-theme-selector.js"]
additional-css = ["./mdbook-code-theme/code-themes.css"]

Otherwise you can create your own theme by adding it to the css file and the list at the top of the js file.