Summary
I'm working on remark-kroki-a11y, a plugin that adds accessibility features to Kroki-generated diagrams. I'd like to explore whether some of this functionality could be integrated into or work better with remark-kroki.
Background
Currently, remark-kroki-a11y wraps the now-archived remark-kroki-plugin to add:
- Source code display - Expandable section showing the diagram source (PlantUML, Mermaid, etc.)
- Natural language descriptions - Deterministic parsers that convert diagram syntax to accessible descriptions for screen readers
- Proper
alt text and aria-describedby - For the generated images
This helps meet WCAG accessibility guidelines for diagrams in documentation.
Relationship to issue #7
I noticed the closed issue #7 (Dual output mode) discussed showing PlantUML source alongside generated diagrams. The solution there was imperative (use remark-code-example), but our approach is declarative with configuration options:
[require('remark-kroki-a11y'), {
showSource: true, // Show source code in expandable section
showA11yDescription: true, // Show natural language description
useTabs: true, // Use tabs vs separate sections
locale: 'en', // For i18n
}]
Question / Proposal
Would you be interested in:
- Collaboration - We could potentially contribute a11y features to
remark-kroki
- Integration - Or design
remark-kroki-a11y to work better as a companion to remark-kroki (we're considering switching from the archived remark-kroki-plugin)
- Feedback - Any thoughts on the best architecture for this?
Why this matters
- Accessibility is increasingly required by law (EU Accessibility Act, ADA, etc.)
- Diagrams are often inaccessible to screen reader users
- Documentation sites need compliant diagram rendering
Resources
Looking forward to your thoughts!
Summary
I'm working on remark-kroki-a11y, a plugin that adds accessibility features to Kroki-generated diagrams. I'd like to explore whether some of this functionality could be integrated into or work better with
remark-kroki.Background
Currently,
remark-kroki-a11ywraps the now-archivedremark-kroki-pluginto add:alttext andaria-describedby- For the generated imagesThis helps meet WCAG accessibility guidelines for diagrams in documentation.
Relationship to issue #7
I noticed the closed issue #7 (Dual output mode) discussed showing PlantUML source alongside generated diagrams. The solution there was imperative (use
remark-code-example), but our approach is declarative with configuration options:Question / Proposal
Would you be interested in:
remark-krokiremark-kroki-a11yto work better as a companion toremark-kroki(we're considering switching from the archivedremark-kroki-plugin)Why this matters
Resources
Looking forward to your thoughts!