diff options
| author | Florian Klink <flokli@flokli.de> | 2024-06-13T18·37+0300 |
|---|---|---|
| committer | clbot <clbot@tvl.fyi> | 2024-06-14T07·04+0000 |
| commit | 4df3284dd0766599148a4a34df59441e9d4dfe70 (patch) | |
| tree | de9edf6d94073eb2feb3cd2089c562eff6e39546 /tvix/docs/book.toml | |
| parent | 9d44da01ee4b889db26681a1f86922f3a5839f0c (diff) | |
feat(tvix/docs): add mdbook-admonish r/8267
This provides a plugin for callouts. It needs to have additional CSS file added to `book.toml`, which can be (re-)generated by `mdbook-admonish install`. See https://github.com/tommilligan/mdbook-admonish/issues/171#issuecomment-2009166079 for more context. Use it by adding a warning one to the architecture document. Change-Id: I75c9a33d00acb603c6da10d3f9ce3485731c1672 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11805 Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de> Reviewed-by: yuka <yuka@yuka.dev>
Diffstat (limited to 'tvix/docs/book.toml')
| -rw-r--r-- | tvix/docs/book.toml | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/tvix/docs/book.toml b/tvix/docs/book.toml index 7318a9023348..10a26f3ff4c0 100644 --- a/tvix/docs/book.toml +++ b/tvix/docs/book.toml @@ -9,3 +9,13 @@ title = "Tvix Docs" # override the /usr/bin/plantuml default plantuml-cmd = "plantuml" use-data-uris = true + +[preprocessor.admonish] +command = "mdbook-admonish" +after = ["links"] # ensure `{{#include}}` also gets processed +assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install` + +[output] + +[output.html] +additional-css = ["./mdbook-admonish.css"] |