From ef01b886865a6873ab754b089b6a8debfc251b23 Mon Sep 17 00:00:00 2001
From: Ivan Dolgov <ivan@qvarnlabs.com>
Date: Fri, 22 Sep 2017 17:07:43 +0300
Subject: Replace Ikiwiki syntax with standard Markdown

---
 docs/plantuml.mdwn | 45 +++++++++++++++------------------------------
 1 file 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 -->
-- 
cgit v1.2.1