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

Use markdown mermaid diagrams in documentation #347

Closed
nuclearcat opened this issue May 2, 2024 · 1 comment
Closed

Use markdown mermaid diagrams in documentation #347

nuclearcat opened this issue May 2, 2024 · 1 comment

Comments

@nuclearcat
Copy link
Member

nuclearcat commented May 2, 2024

Mermaid diagrams supported in github markdown parsing, and probably hugo can support it too, so we can have nice diagrams like this:

mermaid-diagram-2024-05-02-165628
This link clickable and points to live editor:

@JenySadadia
Copy link
Contributor

Yes, we already have a bunch of mermaid digrams for API and Pipeline docs. See https://kernelci.org/docs/api/pipeline-details/

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