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

docs: support for mermaid in mkdocs #3003

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Conversation

MustafaSaber
Copy link
Member

@MustafaSaber MustafaSaber commented Apr 4, 2024

Since mermaid is supported in Markdown maybe it makes sense to add mkdocs support so making a graph later would work on both.

https://mermaid.js.org/syntax/flowchart.html?id=flowcharts-basic-syntax

@MustafaSaber MustafaSaber added the minor no risk changes, for example new filters label Apr 4, 2024

### After

![skipper-with-routesrv](../img/skipper_with_routesrv.svg)
```mermaid
graph TD;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

backward arrows are coming(hopefully) mermaid-js/mermaid#4019

@MustafaSaber MustafaSaber changed the title add support for mermaid in mkdocs since it's suported in markdown now docs: support for mermaid in mkdocs Apr 4, 2024
@MustafaSaber
Copy link
Member Author

image

@szuecs
Copy link
Member

szuecs commented Apr 4, 2024

@MustafaSaber maybe better to not use "Before" and "After" but the configuration you would apply. If you need a title it's "Kubernetes dataclient enabled" and "Kubernetes via routesrv" for example

@AlexanderYastrebov
Copy link
Member

Let fix the pipeline, otherwise 👍

Signed-off-by: Mustafa Abdelrahman <mustafa.abdelrahman@zalando.de>
@MustafaSaber MustafaSaber force-pushed the migrate-routesrv-diagrams branch from 011924b to ac17de2 Compare April 4, 2024 15:28
@AlexanderYastrebov
Copy link
Member

👍

1 similar comment
@szuecs
Copy link
Member

szuecs commented Apr 5, 2024

👍

@szuecs szuecs merged commit 3afe2ab into master Apr 5, 2024
14 checks passed
@szuecs szuecs deleted the migrate-routesrv-diagrams branch April 5, 2024 09:58
@MustafaSaber MustafaSaber self-assigned this May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation minor no risk changes, for example new filters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants