Skip to content

docs: add mermaid plugin for mkdocs#263

Merged
ktro2828 merged 1 commit into
mainfrom
docs/mermaid-plugin
Feb 4, 2026
Merged

docs: add mermaid plugin for mkdocs#263
ktro2828 merged 1 commit into
mainfrom
docs/mermaid-plugin

Conversation

@ktro2828

@ktro2828 ktro2828 commented Feb 4, 2026

Copy link
Copy Markdown
Collaborator

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:

  • Added the mkdocs-mermaid2-plugin to the development dependencies in pyproject.toml to enable Mermaid diagram support.
  • Enabled the mermaid2 plugin in mkdocs.yaml under the plugins section.
  • Configured pymdownx.superfences in mkdocs.yaml to support custom mermaid fences using the mermaid2 plugin, allowing Mermaid diagrams to be rendered in Markdown files.

Pre-commit configuration:

  • Updated .pre-commit-config.yaml to exclude mkdocs.yaml from the check-yaml hook, likely to avoid issues with custom YAML syntax or plugin configuration.

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Copilot AI review requested due to automatic review settings February 4, 2026 02:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-plugin as a development dependency
  • Configured MkDocs to enable Mermaid diagram rendering through the mermaid2 plugin and superfences extension
  • Excluded mkdocs.yaml from 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.

@github-actions github-actions Bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation labels Feb 4, 2026
@ktro2828 ktro2828 self-assigned this Feb 4, 2026
@github-actions

github-actions Bot commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
4231 3471 82% 50% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 8525742 by action🐍

@ktro2828 ktro2828 merged commit 8097e61 into main Feb 4, 2026
4 of 5 checks passed
@ktro2828 ktro2828 deleted the docs/mermaid-plugin branch February 4, 2026 02:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants