summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Dolgov <ivan@qvarnlabs.com>2017-09-22 17:07:43 +0300
committerIvan Dolgov <ivan@qvarnlabs.com>2017-09-22 17:07:43 +0300
commitef01b886865a6873ab754b089b6a8debfc251b23 (patch)
tree6d35eac9107bec392e0eac30e422a358f4d8c121
parentd21718d9911500105ea7b43f03ef19fbb11faf6f (diff)
downloadql-ikiwiki-publish-ef01b886865a6873ab754b089b6a8debfc251b23.tar.gz
Replace Ikiwiki syntax with standard Markdown
-rw-r--r--docs/plantuml.mdwn45
1 files changed, 15 insertions, 30 deletions
diff --git a/docs/plantuml.mdwn b/docs/plantuml.mdwn
index c8d2bca..098d937 100644
--- a/docs/plantuml.mdwn
+++ b/docs/plantuml.mdwn
@@ -28,44 +28,29 @@ So basically what `ql-ikiwiki-publish` will be doing is as follows:
4. Copy the diagram image into Ikiwiki output directory.
-5. Replace embedded diagram code or diagram file include statement with a `img`
- directive containing a path or link to the diagram image.
+5. Replace embedded diagram code or diagram file include statement with an `img`
+ Ikiwiki directive containing a path or link to the diagram image.
### Code block syntax
In case of directly embedded diagram code, the most sensibe syntax seems to be
PlantUML within Markdown code block, which would look like this:
-[[!format md """
-```
-@startuml
-Alice -> Bob: Hello
-Bob -> Alice: Hello
-@enduml
-```
-"""]]
+ @startuml
+ Alice -> Bob: Hello
+ Bob -> Alice: Hello
+ @enduml
-Or like this:
+In case when raw PlantUML code needs to be shown instead of an image, a `format`
+directive can be used to prevent the code from being replaced by
+`ql-ikiwiki-publish`:
-[[!format md """
+ [[!format md """
@startuml
Alice -> Bob: Hello
Bob -> Alice: Hello
@enduml
-"""]]
-
-In case when raw PlantUML code needs to be shown instead of an image, `format`
-directive syntax can be used to prevent the code from being replaced by
-`ql-ikiwiki-publish`:
-
-```
-[[!format md """
-@startuml
-Alice -> Bob: Hello
-Bob -> Alice: Hello
-@enduml
-"""]]
-```
+ """]]
### External file syntax
@@ -73,8 +58,8 @@ In order to include an external diagram code file, we need a custom syntax only
recognizable by `ql-ikiwiki-publish` but preferably ignored by other Markdown
parsers. This can be achieved by using HTML comment syntax:
-[[!format html """
-<!-- INCLUDE_UML: some_file.puml -->
-"""]]
+ <!-- INCLUDE_UML: some_file.puml -->
+
+Pandoc-style triple dash can be also used to make it even more parser-friendly:
-Pandoc-style triple dash can be also used to make it even more parser-friendly.
+ <!--- INCLUDE_UML: some_file.puml -->