Skip to content
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

Merged
merged 3 commits into from
Jan 8, 2023

Conversation

m0ham3dx
Copy link
Contributor

@m0ham3dx m0ham3dx commented Jan 7, 2023

Motivation

  1. This is a followup to THIS message, where I had recommended the addition of the addons in this PR.
  2. In order to increase the comprehension and readability of the manual, the presence of callouts and diagrams would be a good idea

Solution

This PR has the following two mdbook addons

  1. mdbook-mermaid - Ability to add code driven diagrams via mermaid-js
  2. mdbook-admonition - Ability toa dd colorful callouts

Note

  1. In addition to adding the addons , I have also actually implemented both of them in the intro.md, after running the tests on a local branch, the artifacts created now contain the necessary .js and css files in the dir path, as described in their documentation
  2. I have added some styling to the diagrams, colors have been extracted from reth banner. They are altered via hex color codes.
  3. The addons have been directly added in the CI file - book.yaml, so every push should trigger the installation of the necessary files
  4. Maybe I can add a note to the guidance documentation if you see fit.
  5. During my tests all Github Actions have passed except the deployment action.

Q - Does this action require an update in the changelog ? as described in the PR guidance ?

PR Checklist

  • Added Tests
  • Added Documentation
  • Updated the changelog
  • Breaking changes

* CI trigger test with changes

* CI trigger test with changes - type fix

* Post Trigger Rendering Test

* remove actions triggers on P1 branch used during testing
* CI trigger test with changes

* CI trigger test with changes - type fix

* Post Trigger Rendering Test

* remove actions triggers on P1 branch used during testing

* Add example callouts (admonitions) and mermaid diagram in intro.md
book/getting-started/intro.md Outdated Show resolved Hide resolved
@gakonst gakonst merged commit b5eddf1 into gakonst:master Jan 8, 2023
@gakonst
Copy link
Owner

gakonst commented Jan 8, 2023

Sweet - ty. Keen to use more diagrams / callouts.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants