markdown-mermaid-writing
Writes scientific Markdown documentation and Mermaid diagrams for workflows
by k-dense-aiFree
Description
markdown-mermaid-writing is an agent skill for writing scientific Markdown documentation with Mermaid diagrams for workflows, relationships, timelines and schemas. It provides an optional house style and syntax references. The skill ranks the requested output format, the existing conventions of the repository and any journal requirements above its own style. It does not replace scientific analysis or plotting. Its reasoning for using Mermaid is practical: a relationship written as Mermaid inside a .md file is editable text that diffs cleanly in git, and a compatible host renders it without a separate build step. The skill is candid about limits. The diagram renders only where the host supports Mermaid, plain Markdown viewers may show only the code, and platforms and extensions ship different Mermaid versions. Token use depends on the diagram. Exporting SVG or PNG files needs a renderer, and the skill advises keeping the diagram source alongside any exported figure. Use it when you are documenting a pipeline, a data model or a project timeline in a repository, and you want the diagrams to live in the text.…
Highlights
- Scientific Markdown documentation
- Mermaid diagrams for workflows and schemas
- Syntax references
- Diagram source stays diffable in git
- Keeps the source with exported figures
Ratings & Reviews
No ratings yet
Be the first to rate markdown-mermaid-writing.
People also visit
markdown-mermaid-writing FAQ
What does it write?
Scientific Markdown documentation with Mermaid diagrams for workflows, relationships, timelines and schemas.
Why Mermaid inside Markdown?
The skill says it is editable text that diffs cleanly in git and renders in a compatible host without a separate build step.
Will the diagrams render everywhere?
No. Plain Markdown viewers may show only the code, and platforms ship different Mermaid versions.
What about exported images?
Exporting SVG or PNG needs a renderer. The skill advises keeping the diagram source alongside exported figures.
How do I install it?
Run npx skills add https://github.com/k-dense-ai/scientific-agent-skills --skill markdown-mermaid-writing.
Is it checked for security?
Its security audits show passes from Gen Agent Trust Hub, Socket and Snyk.
What are the best markdown-mermaid-writing alternatives?
Popular alternatives to markdown-mermaid-writing include mermaid-diagram-specialist, lark-whiteboard and draft-openspec-docs. See all markdown-mermaid-writing alternatives