docs: add mermaid plugin for mkdocs#263
Merged
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds Mermaid diagram support to the project's MkDocs documentation system by installing and configuring the mermaid2 plugin.
Changes:
- Added
mkdocs-mermaid2-pluginas a development dependency - Configured MkDocs to enable Mermaid diagram rendering through the mermaid2 plugin and superfences extension
- Excluded
mkdocs.yamlfrom pre-commit YAML validation due to custom YAML syntax
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Added mkdocs-mermaid2-plugin to development dependencies |
| mkdocs.yaml | Enabled mermaid2 plugin and configured superfences to support Mermaid diagram rendering |
| .pre-commit-config.yaml | Excluded mkdocs.yaml from check-yaml hook |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
This pull request updates the documentation build system to add support for Mermaid diagrams in MkDocs. The changes primarily focus on enabling and configuring the Mermaid plugin, as well as updating pre-commit and development dependencies.
Documentation build enhancements:
mkdocs-mermaid2-pluginto the development dependencies inpyproject.tomlto enable Mermaid diagram support.mermaid2plugin inmkdocs.yamlunder thepluginssection.pymdownx.superfencesinmkdocs.yamlto support custommermaidfences using themermaid2plugin, allowing Mermaid diagrams to be rendered in Markdown files.Pre-commit configuration:
.pre-commit-config.yamlto excludemkdocs.yamlfrom thecheck-yamlhook, likely to avoid issues with custom YAML syntax or plugin configuration.