Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add diagramming feature via Mermaid (see Hugo Learn Theme for reference) #26

Open
aral opened this issue Dec 25, 2017 · 1 comment
Open

Comments

@aral
Copy link

aral commented Dec 25, 2017

The Hugo Learn Theme has Mermaid-based diagramming by default. This would be a valuable addition to Cupper and should be relatively easy to port from that theme.

(Also, see the Typora editor app – which also uses Mermaid internally – for a possible front-end for authoring and rapidly prototyping documentation with diagrams in Markdown for Cupper.)

Reference: https://learn.netlify.com/en/
Source: https://github.com/matcornic/hugo-theme-learn

@frastlin
Copy link

frastlin commented Dec 9, 2018

The problem is that the Mermaid diagrams are not very accessible with a screen reader. The alt text does not give nearly enough information to be useful. It would be better if the code was the alt text, as it's more understandable.
The diagrams need some work before they could be considered inclusive for screen reader users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants