diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml index d891d71..a0fc1a5 100644 --- a/.github/workflows/mdbook.yml +++ b/.github/workflows/mdbook.yml @@ -29,15 +29,19 @@ jobs: build: runs-on: ubuntu-latest env: - MDBOOK_VERSION: 0.4.36 + MDBOOK_VERSION: 0.4.52 + MDBOOK_MERMAID_VERSION: 0.10.0 steps: - uses: actions/checkout@v4 - name: Install mdBook run: | curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh rustup update + # Install mdbook v0.4.52 (required for mdbook-embedify compatibility) cargo install --version ${MDBOOK_VERSION} mdbook - cargo install mdbook-mermaid + # Install mdbook-mermaid v0.10.0 (compatible with mdbook 0.4.52) + cargo install --version ${MDBOOK_MERMAID_VERSION} mdbook-mermaid + # Install mdbook-embedify (latest version compatible with mdbook 0.4.52) cargo install mdbook-embedify - name: Setup Pages id: pages diff --git a/MDBOOK.md b/MDBOOK.md index bb50e83..86d02b8 100644 --- a/MDBOOK.md +++ b/MDBOOK.md @@ -13,19 +13,22 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh To install mdBook, run the following command: ```bash -cargo install mdbook +# Install mdbook v0.4.52 (required for mdbook-embedify compatibility) +cargo install mdbook --version 0.4.52 ``` Install required preprocessors: ```sh -# Install mdbook-mermaid for Mermaid diagram support -cargo install mdbook-mermaid +# Install mdbook-mermaid v0.10.0 (compatible with mdbook 0.4.52) +cargo install mdbook-mermaid --version 0.10.0 # Install mdbook-embedify for embedding external content cargo install mdbook-embedify ``` +**Note:** These specific versions are required for compatibility. mdbook-embedify 0.2.18 is not compatible with mdbook 0.5.x, so we use mdbook 0.4.52 and a compatible version of mdbook-mermaid. + ## Usage To build the book, run the following command: diff --git a/book.toml b/book.toml index af99597..679b292 100644 --- a/book.toml +++ b/book.toml @@ -1,28 +1,23 @@ [book] authors = ["InnerSource Commons"] language = "en" -multilingual = false src = "." title = "How To Create An InnerSource Program Office" -[preprocessor] - [preprocessor.mermaid] command = "mdbook-mermaid" [preprocessor.embedify] giscus.enable = true giscus.repo = "InnerSourceCommons/managing-innersource-projects" -giscus.repo-id = "MDEwOlJlcG9zaXRvcnk4MjY2ODc3OA==" +giscus."repo-id" = "MDEwOlJlcG9zaXRvcnk4MjY2ODc3OA==" giscus.category = "Website" -giscus.category-id = "DIC_kwDOBO1s6s4CiMTg" -giscus.reactions-enabled = "1" +giscus."category-id" = "DIC_kwDOBO1s6s4CiMTg" +giscus."reactions-enabled" = "1" giscus.theme = "preferred_color_scheme" giscus.lang = "en" -giscus.loading = "eager" +giscus.loading = "lazy" giscus.crossorigin = "anonymous" -[output] - [output.html] additional-js = ["mermaid.min.js", "mermaid-init.js"]