From 94d7ba01ca57f22d397ac227159a399cbaf55df6 Mon Sep 17 00:00:00 2001 From: 9Lukas5 Date: Sat, 19 Dec 2020 21:37:13 +0100 Subject: [PATCH] refactor(docs/dev-guide/workflow): use tabbed env for plantuml example got fixed in plantuml-markdown 3.4.2 --- docs/developers-guide/workflow.md | 66 +++++++++++++++---------------- 1 file changed, 31 insertions(+), 35 deletions(-) diff --git a/docs/developers-guide/workflow.md b/docs/developers-guide/workflow.md index 7373caa..642d0f6 100644 --- a/docs/developers-guide/workflow.md +++ b/docs/developers-guide/workflow.md @@ -251,41 +251,37 @@ You have to surround the PlantUML code with code fences, marked as `plantuml` as language identifier. Then they will be rendered into an svg on pages creation. -!!! bug - I tried to put this into an collapsed example admonition, - but the PlantUML diagram get's always placed outside the admonition. - Same applies for a tabbed environment. - -Example: -__code:__ -`````` -```plantuml -queue "write\nmarkdown" as write -queue "commit/push/\nmerge changes" as update -queue "pipeline\ntriggered" as cicd -queue "MkDocs\nMaterial" as MkDocsMat -queue "transpiled HTML\nonline" as deployed - -write -right-> update -update -right-> cicd -cicd -right-> MkDocsMat -MkDocsMat -right-> deployed -``` -`````` - -__result:__ -```plantuml -queue "write\nmarkdown" as write -queue "commit/push/\nmerge changes" as update -queue "pipeline\ntriggered" as cicd -queue "MkDocs\nMaterial" as MkDocsMat -queue "transpiled HTML\nonline" as deployed - -write -right-> update -update -right-> cicd -cicd -right-> MkDocsMat -MkDocsMat -right-> deployed -``` +Example: + +=== "code" + `````` + ```plantuml + queue "write\nmarkdown" as write + queue "commit/push/\nmerge changes" as update + queue "pipeline\ntriggered" as cicd + queue "MkDocs\nMaterial" as MkDocsMat + queue "transpiled HTML\nonline" as deployed + + write -right-> update + update -right-> cicd + cicd -right-> MkDocsMat + MkDocsMat -right-> deployed + ``` + `````` + +=== "result" + ```plantuml + queue "write\nmarkdown" as write + queue "commit/push/\nmerge changes" as update + queue "pipeline\ntriggered" as cicd + queue "MkDocs\nMaterial" as MkDocsMat + queue "transpiled HTML\nonline" as deployed + + write -right-> update + update -right-> cicd + cicd -right-> MkDocsMat + MkDocsMat -right-> deployed + ``` ## Schedule a release -- GitLab