nodejs / nodejs/nodejs.org

Mermaid diagram support

Open
#7,540 5 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
TypeScript
Stars
6.9k
Forks
6.5k
Avg merge
2d 8h
Merged PRs (30d)
29

Description

Enter your suggestions in details:

Adding support for mermaid diagrams (https://mermaid.js.org/) in blog posts could help with making diagrams. Was trying this out for the upcoming blog post for the r2 migration, but haven't been able to get it working

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 reading the Mermaid documentation and tracing how blog posts are rendered in nodejs.org, using the r2 migration blog post as the concrete example. Determine where diagram support would fit and verify that a blog post containing a Mermaid diagram renders correctly before considering the issue done.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.