Skip to content

build(dev-deps): add mermaid plugin to docs #641

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

Merged
merged 1 commit into from
Mar 14, 2022

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR adds the plugin that allows to use mermaid diagrams in the MKDocs documentation as discussed in our last meeting.

How to verify this change

image

**Note:** the diagram above is just an example to verify that the plugin works, it is not part of the changes.

Related issues, RFCs

N/A

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

Breaking change checklist

N/A


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi added documentation Improvements or additions to documentation dependencies Changes that touch dependencies, e.g. Dependabot, etc. labels Mar 8, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone Mar 8, 2022
@dreamorosi dreamorosi self-assigned this Mar 8, 2022
@dreamorosi dreamorosi requested a review from saragerion March 9, 2022 13:29
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

Nice!

Copy link
Contributor

@ijemmy ijemmy left a comment

Choose a reason for hiding this comment

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

We need this diagram to highlight that we're using npm8.x soon :D

@dreamorosi dreamorosi merged commit 9fba1d3 into main Mar 14, 2022
@dreamorosi dreamorosi deleted the aamorosi/npm_and_yarn/mkdocs branch March 14, 2022 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants