processing / processing/p5.js-website
Adding Mermaid diagram support
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 96
- Forks
- 322
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 8
Description
In one of our contributor docs, we have a diagram rendered with Mermaid since GitHub is able to render those in its readmes. A writer currently working on the documentation for functions like applyMatrix also was wondering if we could use something like GitHub readme inline math in documentation.
We don't necessarily need to implement any of these right away, but do you have a sense of what it would take to integrate them in the future?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing src/content/contributor-docs/en/webgl_mode_architecture.mdx and the linked GitHub guidance for Mermaid diagrams and mathematical expressions. Determine what would be required to support these formats in the contributor documentation, and document the integration options and remaining questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100