This repository has been archived by the owner on Oct 19, 2024. It is now read-only.
mx - CI - mdbook addons - admonition(callouts) and mermaid (code driven diagrams) with example implementation #2025
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Solution
This PR has the following two mdbook addons
mdbook-mermaid
- Ability to add code driven diagrams viamermaid-js
mdbook-admonition
- Ability toa dd colorful calloutsNote
intro.md
, after running the tests on a local branch, the artifacts created now contain the necessary.js
andcss
files in the dir path, as described in their documentationbook.yaml
, so every push should trigger the installation of the necessary filesQ - Does this action require an update in the changelog ? as described in the PR guidance ?
PR Checklist