abpframework / abpframework/abp

Add Mermaid Syntax Support for Docs and CMS Kit

Open
#17,817 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
C#
Stars
14.4k
Forks
3.7k
Avg merge
15h 32m
Merged PRs (30d)
106

Description

Is there an existing issue for this?
  • I have searched the existing issues
Is your feature request related to a problem? Please describe the problem.

I am trying to insert charts and graphs into my documents to show a user a project flow, but I cannot use common markdown syntax to put in mermaid charts.
I also cannot implement these code discussions on my blog, as the CMS Kit does not support them.

Describe the solution you'd like

I would like an implementation of Mermaid placed into the CMS Kit, and into the Docs module, so that we can display charts rather than having to link to https://mermaid.live with a massive URL string.

Additional context

There are a number of users on the Discord who have reacted well to the suggestion int he Ideas channel.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Docs module and CMS Kit rendering or Markdown pipelines, then determine how supported content extensions are integrated. The work is done when Mermaid syntax renders charts in both areas without requiring external mermaid.live links, with coverage for the relevant rendering paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
content, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.