diff --git a/.github/workflows/deploy-github-pages.yaml b/.github/workflows/deploy-github-pages.yaml index 74ac6c8..2b18ea1 100644 --- a/.github/workflows/deploy-github-pages.yaml +++ b/.github/workflows/deploy-github-pages.yaml @@ -37,6 +37,15 @@ jobs: with: target: mdbook-mermaid + - name: Install mdbook-admonish + uses: ./.github/actions/cargo-install + with: + target: mdbook-admonish + + - name: Install mdbook-dependencies + working-directory: docs + run: mdbook-admonish install + - name: Install cargo-llvm-cov uses: taiki-e/install-action@cargo-llvm-cov diff --git a/docs/.gitignore b/docs/.gitignore index 2eb9938..b9ce7b6 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,4 @@ book mermaid-init.js mermaid.min.js +mdbook-admonish.css diff --git a/docs/book.toml b/docs/book.toml index 5ec83fc..bc3d6e1 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -8,5 +8,10 @@ title = "Alloy Game Engine (Rust)" [preprocessor.mermaid] command = "mdbook-mermaid" +[preprocessor.admonish] +command = "mdbook-admonish" +assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install` + [output.html] additional-js = ["mermaid.min.js", "mermaid-init.js"] +additional-css = ["./mdbook-admonish.css"] diff --git a/docs/src/community.md b/docs/src/community.md index 0a08ad7..58b570e 100644 --- a/docs/src/community.md +++ b/docs/src/community.md @@ -1,5 +1,10 @@ # Community +```admonish note +This community section aggregates the same community-contribution files that +can be found from within the GitHub UI. +``` + 1. [Code of Conduct](./community/CODE_OF_CONDUCT.md) 2. [Contributing](./community/CONTRIBUTING.md) 3. [Project Governance](./community/GOVERNANCE.md) diff --git a/docs/src/tour/editors.md b/docs/src/tour/editors.md index 7e0f241..b21c672 100644 --- a/docs/src/tour/editors.md +++ b/docs/src/tour/editors.md @@ -1,5 +1,10 @@ # Tour of the Editors +```admonish note +Many of these sections are "forward-thinking" as these are still +in-progress unless otherwise specified. +``` + This section provides a tour of the different editors that are available within Alloy. diff --git a/docs/src/tour/engine.md b/docs/src/tour/engine.md index e7089cf..9cdef55 100644 --- a/docs/src/tour/engine.md +++ b/docs/src/tour/engine.md @@ -1,5 +1,10 @@ # Tour of the Alloy Engine +```admonish note +Many of these sections are "forward-thinking" as these are still +in-progress unless otherwise specified. +``` + This is a tour of the Alloy Engine's software integration. This section will provide detailed instructions to set up and prepare an Alloy application.