summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Dolgov <ivan@qvarnlabs.com>2017-10-06 13:14:04 +0300
committerIvan Dolgov <ivan@qvarnlabs.com>2017-10-06 13:14:04 +0300
commit712aad38d5c9a2fec53a5e6cc454fb0b4e107de0 (patch)
treecb2aa8975c6f2c81ad6fd83830d5bdb2bf7abd83
parentc2b9b321673d1b3c1bf9ed55f18c7c7e4186746a (diff)
downloadql-ikiwiki-publish-712aad38d5c9a2fec53a5e6cc454fb0b4e107de0.tar.gz
Tweak docs and other small things
-rw-r--r--docs/plantuml-test/ikiwiki.setup2
-rw-r--r--docs/plantuml-test/index.mdwn3
-rw-r--r--docs/plantuml.mdwn8
3 files changed, 10 insertions, 3 deletions
diff --git a/docs/plantuml-test/ikiwiki.setup b/docs/plantuml-test/ikiwiki.setup
index da4b876..d7e7c32 100644
--- a/docs/plantuml-test/ikiwiki.setup
+++ b/docs/plantuml-test/ikiwiki.setup
@@ -1,8 +1,6 @@
# IkiWiki::Setup::Yaml - YAML formatted setup file
wikiname: PlantUML test wiki
-srcdir: .
-destdir: .
add_plugins:
- img
- highlight
diff --git a/docs/plantuml-test/index.mdwn b/docs/plantuml-test/index.mdwn
index 34cf032..582073a 100644
--- a/docs/plantuml-test/index.mdwn
+++ b/docs/plantuml-test/index.mdwn
@@ -2,7 +2,8 @@
# PlantUML test page
-Everything is OK, if you don't see source code (PlantUML or Ikiwiki) on this page.
+Everything is OK, if you don't see any source code (PlantUML or Ikiwiki)
+on this page.
## Code block syntax
diff --git a/docs/plantuml.mdwn b/docs/plantuml.mdwn
index 098d937..3178927 100644
--- a/docs/plantuml.mdwn
+++ b/docs/plantuml.mdwn
@@ -63,3 +63,11 @@ parsers. This can be achieved by using HTML comment syntax:
Pandoc-style triple dash can be also used to make it even more parser-friendly:
<!--- INCLUDE_UML: some_file.puml -->
+
+## Testing
+
+Run `ql-ikiwiki-publish` against a provided test page:
+
+ cd docs/plantuml-test/
+ ../../ql-ikiwiki-publish
+ firefox ...