Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown rendering for mermaid diagrams and notes #1669

Merged

Conversation

albinsuresh
Copy link
Contributor

@albinsuresh albinsuresh commented Jan 2, 2023

Proposed changes

This PR includes two markdown rendering improvements:

  1. Render mermaid diagrams using https://github.com/badboy/mdbook-mermaid
  2. Render admonish blocks for note, warning and example blocks using https://tommilligan.github.io/mdbook-admonish/

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#1661

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be good to update the README to install all the mdbook add-ons.

cargo install mdbook mdbook-linkcheck mdbook-mermaid mdbook-admonish

There is also a warning on mdbook build: The command wasn't found, is the "admonish" preprocessor installed?. One needs to update the files gh-pages.yml and pull-request-check.yaml.

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@albinsuresh albinsuresh force-pushed the bug/1661/fix-mermaid-rendering branch from eb5dd41 to f9c608a Compare January 4, 2023 05:55
@albinsuresh albinsuresh merged commit 935bb98 into thin-edge:main Jan 4, 2023
@albinsuresh albinsuresh deleted the bug/1661/fix-mermaid-rendering branch March 8, 2023 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants