Skip to content

Commit

Permalink
MDBook fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@shimkiv
shimkiv committed Sep 18, 2024
1 parent ffe8911 commit 8a5b04f
Show file tree
Hide file tree
Showing 24 changed files with 253 additions and 213 deletions.
4 changes: 2 additions & 2 deletions book/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ license = "Apache-2.0"

[build-dependencies]
cargo-spec = { version = "0.5.0" }
time = { version = "~0.3.23" } # This crate is a known bad-actor for breaking rust version support.
plist = { version = "~1.5.0" } # This crate improperly constrains its bad-actor dependency (`time`).
time = { version = "~0.3.23" } # This crate is a known bad-actor for breaking rust version support.
plist = { version = "~1.5.0" } # This crate improperly constrains its bad-actor dependency (`time`).
47 changes: 29 additions & 18 deletions book/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,61 @@
# list versions of mdbook and mdbook plugins
#

MDBOOK_VERSION = 0.4.27
MDBOOK_ADMONISH_VERSION = 1.8.0
MDBOOK_VERSION = 0.4.35
MDBOOK_KATEX_VERSION = 0.3.8
MDBOOK_LINKCHECK_VERSION = 0.7.6
MDBOOK_ADMONISH_VERSION = 1.14.0
MDBOOK_LINKCHECK_VERSION = 0.7.7
MDBOOK_MERMAID_VERSION = 0.12.6
MDBOOK_TOC_VERSION = 0.11.2
MDBOOK_TOC_VERSION = 0.14.1


all: deps check build serve

#
# use `make deps` to install the dependencies required to serve or build the book
# Installs the dependencies required to serve or build the book
#

deps:
cargo install "mdbook@$(MDBOOK_VERSION)"
cargo install "mdbook-admonish@$(MDBOOK_ADMONISH_VERSION)"
cargo install "mdbook-katex@$(MDBOOK_KATEX_VERSION)"
# cargo install "mdbook-linkcheck@$(MDBOOK_LINKCHECK_VERSION)"
cargo install "mdbook-mermaid@$(MDBOOK_MERMAID_VERSION)"
cargo install "mdbook-toc@$(MDBOOK_TOC_VERSION)"
cargo install --locked "mdbook@$(MDBOOK_VERSION)"
cargo install --locked "mdbook-admonish@$(MDBOOK_ADMONISH_VERSION)"
cargo install --locked "mdbook-katex@$(MDBOOK_KATEX_VERSION)"
cargo install --locked --git https://github.com/o1-labs/mdbook-linkcheck --rev 8cccfc8fee397092ecdf1236a42871c5c980672e mdbook-linkcheck
cargo install --locked "mdbook-mermaid@$(MDBOOK_MERMAID_VERSION)"
cargo install --locked "mdbook-toc@$(MDBOOK_TOC_VERSION)"

#
# use `make check` to check if your installed dependencies match what we've listed above
# Checks if your installed dependencies match what we've listed above
#

define check_version
(cargo install --list | grep "$(1) v" | cut -d " " -f 2 | tr -d ':' | grep -Fx "v$(2)") || (echo "your $(1) version needs to be $(2)" && exit 1)
@(cargo install --list | grep "$(1) v" | cut -d " " -f 2 | tr -d ':' | grep -Fx "v$(2)") || (echo "your $(1) version needs to be $(2)" && exit 1)
endef

check:
$(call check_version,mdbook,$(MDBOOK_VERSION))
$(call check_version,mdbook-admonish,$(MDBOOK_ADMONISH_VERSION))
$(call check_version,mdbook-katex,$(MDBOOK_KATEX_VERSION))
$(call check_version,mdbook-linkcheck,$(MDBOOK_LINKCHECK_VERSION))
$(call check_version,mdbook-mermaid,$(MDBOOK_MERMAID_VERSION))
$(call check_version,mdbook-toc,$(MDBOOK_TOC_VERSION))

#
# use `make` to serve the book locally
# Builds the book
#

build: check
mdbook build

#
# Serves the book locally
#

all: check
serve: check
mdbook serve --open

#
# use `make build` to build the book
# Cleans the generated artefacts
#

build: check
mdbook build
clean:
mdbook clean
2 changes: 2 additions & 0 deletions book/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ $ # install dependencies
$ make deps
$ # serve the page locally
$ make
$ # clean
$ make clean
```

The specifications in the book are dynamically generated. Refer to the [specifications/](specifications/) directory.
92 changes: 40 additions & 52 deletions book/assets/css/mdbook-admonish.css
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,16 @@
:root {
--md-admonition-icon--note:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");
--md-admonition-icon--abstract:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");
--md-admonition-icon--info:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");
--md-admonition-icon--tip:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");
--md-admonition-icon--success:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");
--md-admonition-icon--question:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");
--md-admonition-icon--warning:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");
--md-admonition-icon--failure:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");
--md-admonition-icon--danger:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");
--md-admonition-icon--bug:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");
--md-admonition-icon--example:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");
--md-admonition-icon--quote:
url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");
--md-admonition-icon--note: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");
--md-admonition-icon--abstract: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");
--md-admonition-icon--info: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");
--md-admonition-icon--tip: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");
--md-admonition-icon--success: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");
--md-admonition-icon--question: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");
--md-admonition-icon--warning: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");
--md-admonition-icon--failure: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");
--md-admonition-icon--danger: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");
--md-admonition-icon--bug: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");
--md-admonition-icon--example: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");
--md-admonition-icon--quote: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");
}

:is(.admonition) {
Expand All @@ -44,7 +32,7 @@
}
}

:is(.admonition)>* {
:is(.admonition) > * {
box-sizing: border-box;
}

Expand All @@ -53,11 +41,11 @@
margin-bottom: 1em;
}

:is(.admonition)>.tabbed-set:only-child {
:is(.admonition) > .tabbed-set:only-child {
margin-top: 0;
}

html :is(.admonition)> :last-child {
html :is(.admonition) > :last-child {
margin-bottom: 1.2rem;
}

Expand Down Expand Up @@ -110,11 +98,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #448aff;
}

:is(.note)> :is(.admonition-title, summary) {
:is(.note) > :is(.admonition-title, summary) {
background-color: rgba(68, 138, 255, 0.1);
}

:is(.note)> :is(.admonition-title, summary)::before {
:is(.note) > :is(.admonition-title, summary)::before {
background-color: #448aff;
mask-image: var(--md-admonition-icon--note);
-webkit-mask-image: var(--md-admonition-icon--note);
Expand All @@ -128,11 +116,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #00b0ff;
}

:is(.abstract, .summary, .tldr)> :is(.admonition-title, summary) {
:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary) {
background-color: rgba(0, 176, 255, 0.1);
}

:is(.abstract, .summary, .tldr)> :is(.admonition-title, summary)::before {
:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary)::before {
background-color: #00b0ff;
mask-image: var(--md-admonition-icon--abstract);
-webkit-mask-image: var(--md-admonition-icon--abstract);
Expand All @@ -146,11 +134,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #00b8d4;
}

:is(.info, .todo)> :is(.admonition-title, summary) {
:is(.info, .todo) > :is(.admonition-title, summary) {
background-color: rgba(0, 184, 212, 0.1);
}

:is(.info, .todo)> :is(.admonition-title, summary)::before {
:is(.info, .todo) > :is(.admonition-title, summary)::before {
background-color: #00b8d4;
mask-image: var(--md-admonition-icon--info);
-webkit-mask-image: var(--md-admonition-icon--info);
Expand All @@ -164,11 +152,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #00bfa5;
}

:is(.tip, .hint, .important)> :is(.admonition-title, summary) {
:is(.tip, .hint, .important) > :is(.admonition-title, summary) {
background-color: rgba(0, 191, 165, 0.1);
}

:is(.tip, .hint, .important)> :is(.admonition-title, summary)::before {
:is(.tip, .hint, .important) > :is(.admonition-title, summary)::before {
background-color: #00bfa5;
mask-image: var(--md-admonition-icon--tip);
-webkit-mask-image: var(--md-admonition-icon--tip);
Expand All @@ -182,11 +170,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #00c853;
}

:is(.success, .check, .done)> :is(.admonition-title, summary) {
:is(.success, .check, .done) > :is(.admonition-title, summary) {
background-color: rgba(0, 200, 83, 0.1);
}

:is(.success, .check, .done)> :is(.admonition-title, summary)::before {
:is(.success, .check, .done) > :is(.admonition-title, summary)::before {
background-color: #00c853;
mask-image: var(--md-admonition-icon--success);
-webkit-mask-image: var(--md-admonition-icon--success);
Expand All @@ -200,11 +188,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #64dd17;
}

:is(.question, .help, .faq)> :is(.admonition-title, summary) {
:is(.question, .help, .faq) > :is(.admonition-title, summary) {
background-color: rgba(100, 221, 23, 0.1);
}

:is(.question, .help, .faq)> :is(.admonition-title, summary)::before {
:is(.question, .help, .faq) > :is(.admonition-title, summary)::before {
background-color: #64dd17;
mask-image: var(--md-admonition-icon--question);
-webkit-mask-image: var(--md-admonition-icon--question);
Expand All @@ -218,11 +206,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #ff9100;
}

:is(.warning, .caution, .attention)> :is(.admonition-title, summary) {
:is(.warning, .caution, .attention) > :is(.admonition-title, summary) {
background-color: rgba(255, 145, 0, 0.1);
}

:is(.warning, .caution, .attention)> :is(.admonition-title, summary)::before {
:is(.warning, .caution, .attention) > :is(.admonition-title, summary)::before {
background-color: #ff9100;
mask-image: var(--md-admonition-icon--warning);
-webkit-mask-image: var(--md-admonition-icon--warning);
Expand All @@ -236,11 +224,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #ff5252;
}

:is(.failure, .fail, .missing)> :is(.admonition-title, summary) {
:is(.failure, .fail, .missing) > :is(.admonition-title, summary) {
background-color: rgba(255, 82, 82, 0.1);
}

:is(.failure, .fail, .missing)> :is(.admonition-title, summary)::before {
:is(.failure, .fail, .missing) > :is(.admonition-title, summary)::before {
background-color: #ff5252;
mask-image: var(--md-admonition-icon--failure);
-webkit-mask-image: var(--md-admonition-icon--failure);
Expand All @@ -254,11 +242,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #ff1744;
}

:is(.danger, .error)> :is(.admonition-title, summary) {
:is(.danger, .error) > :is(.admonition-title, summary) {
background-color: rgba(255, 23, 68, 0.1);
}

:is(.danger, .error)> :is(.admonition-title, summary)::before {
:is(.danger, .error) > :is(.admonition-title, summary)::before {
background-color: #ff1744;
mask-image: var(--md-admonition-icon--danger);
-webkit-mask-image: var(--md-admonition-icon--danger);
Expand All @@ -272,11 +260,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #f50057;
}

:is(.bug)> :is(.admonition-title, summary) {
:is(.bug) > :is(.admonition-title, summary) {
background-color: rgba(245, 0, 87, 0.1);
}

:is(.bug)> :is(.admonition-title, summary)::before {
:is(.bug) > :is(.admonition-title, summary)::before {
background-color: #f50057;
mask-image: var(--md-admonition-icon--bug);
-webkit-mask-image: var(--md-admonition-icon--bug);
Expand All @@ -290,11 +278,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #7c4dff;
}

:is(.example)> :is(.admonition-title, summary) {
:is(.example) > :is(.admonition-title, summary) {
background-color: rgba(124, 77, 255, 0.1);
}

:is(.example)> :is(.admonition-title, summary)::before {
:is(.example) > :is(.admonition-title, summary)::before {
background-color: #7c4dff;
mask-image: var(--md-admonition-icon--example);
-webkit-mask-image: var(--md-admonition-icon--example);
Expand All @@ -308,11 +296,11 @@ html :is(.admonition-title, summary):last-child {
border-color: #9e9e9e;
}

:is(.quote, .cite)> :is(.admonition-title, summary) {
:is(.quote, .cite) > :is(.admonition-title, summary) {
background-color: rgba(158, 158, 158, 0.1);
}

:is(.quote, .cite)> :is(.admonition-title, summary)::before {
:is(.quote, .cite) > :is(.admonition-title, summary)::before {
background-color: #9e9e9e;
mask-image: var(--md-admonition-icon--quote);
-webkit-mask-image: var(--md-admonition-icon--quote);
Expand All @@ -339,4 +327,4 @@ html :is(.admonition-title, summary):last-child {
.rust .admonition-anchor-link:link,
.rust .admonition-anchor-link:visited {
color: var(--sidebar-fg);
}
}
27 changes: 23 additions & 4 deletions book/book.toml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
[book]
authors = ["Izaak Meckler", "Vanishree Rao", "Mathias Hall-Andersen", "Matthew Ryan", "Joseph Spadavecchia", "David Wong", "Vitaly Zelov"]
authors = [
"Izaak Meckler",
"Vanishree Rao",
"Mathias Hall-Andersen",
"Matthew Ryan",
"Joseph Spadavecchia",
"David Wong",
"Vitaly Zelov",
]
language = "en"
multilingual = false
src = "src"
Expand All @@ -10,18 +18,20 @@ site-url = "/proof-systems/"
use-site-url-as-root = true
curly-quotes = true
git-repository-url = "https://www.github.com/o1-labs/proof-systems"
additional-css = ["./assets/css/mdbook-admonish.css", "././mdbook-admonish.css"]
additional-css = ["./assets/css/mdbook-admonish.css", "./mdbook-admonish.css"]
additional-js = ["mermaid.min.js", "mermaid-init.js"]

# for LaTeX
[output.katex]
[preprocessor.katex]
macros = "macros.txt" # crypto related macros (as close to cryptocode as possible)
macros = "macros.txt" # crypto related macros (as close to cryptocode as possible)
throw-on-error = true
error-color = "#cc0000"

# for callouts
[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
assets_version = "3.0.1" # do not edit: managed by `mdbook-admonish install`

# for protocol diagrams
[preprocessor.mermaid]
Expand All @@ -31,3 +41,12 @@ command = "mdbook-mermaid"
[preprocessor.toc]
command = "mdbook-toc"
renderer = ["html"]


# See docs:
# - https://github.com/o1-labs/mdbook-linkcheck
# - (original repo) https://github.com/Michael-F-Bryan/mdbook-linkcheck
[output.linkcheck]
follow-web-links = false
traverse-parent-directories = false
latex-support = true
Loading

0 comments on commit 8a5b04f

Please sign in to comment.