book: add mermaid-js support

TEST=mdbook docs/book
BUG=None

Change-Id: I63c487e3718ed47f7084b211fa398422b8b571fa
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/2991090
Reviewed-by: Dennis Kempin <denniskempin@google.com>
Tested-by: Dennis Kempin <denniskempin@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Dennis Kempin <denniskempin@google.com>
This commit is contained in:
Zach Reizner 2021-06-25 16:15:55 -04:00 committed by Commit Bot
parent 81f717b152
commit 7a96510dcd
4 changed files with 45 additions and 2 deletions

View file

@ -5,8 +5,6 @@
# Base image for crosvm_builder and crosvm_aarch64_builder containing basic
# devleopment environment for building rust.
# TODO(b/177078591): Use debian buster and backports (or manual dpkg downloads)
# of outdated libraries. Sid could blow up on us any day.
FROM debian:buster
# Set timezone so apt-get won't try to prompt
@ -64,6 +62,10 @@ ENV PATH="/root/.cargo/bin:${PATH}"
# The bindgen tool is required to build a crosvm dependency.
RUN cargo install bindgen
# The mdbook and mdbook-mermaid tools are used to build the crosvm book.
RUN cargo install mdbook --no-default-features --version "^0.4.10"
RUN cargo install mdbook-mermaid --version "^0.8.3"
# Point cargo to store data on the scratch volume.
ENV CARGO_TARGET_DIR=/workspace/scratch/cargo_target
ENV CARGO_HOME=/workspace/scratch/cargo_home

View file

@ -4,3 +4,11 @@ language = "en"
multilingual = false
src = "src"
title = "Book of crosvm"
[preprocessor]
[preprocessor.mermaid]
command = "mdbook-mermaid"
[output]
[output.html]
additional-js = ["mermaid.min.js", "mermaid-init.js"]

View file

@ -0,0 +1 @@
mermaid.initialize({startOnLoad:true});

32
docs/book/mermaid.min.js vendored Normal file

File diff suppressed because one or more lines are too long