Skip to content

Do we support Mermaid diagrams and inline math? #168

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

Open
davepagurek opened this issue Apr 8, 2024 · 1 comment
Open

Do we support Mermaid diagrams and inline math? #168

davepagurek opened this issue Apr 8, 2024 · 1 comment

Comments

@davepagurek
Copy link
Collaborator

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?

@stalgiag
Copy link
Collaborator

The former would likely require a plugin, ideally one that supports server-side rendering (to reduce package size). I don't know how different pintora is from mermaid but I see this pintora plugin for Astro.

The latter would just require specific styles.

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