aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/txt.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/txt.mdwn')
-rw-r--r--doc/plugins/txt.mdwn14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/plugins/txt.mdwn b/doc/plugins/txt.mdwn
new file mode 100644
index 000000000..8d8cb55c2
--- /dev/null
+++ b/doc/plugins/txt.mdwn
@@ -0,0 +1,14 @@
+[[template id=plugin name=txt author="[[Gabriel]]"]]
+[[tag type/format]]
+
+This plugin makes ikiwiki treat files with names ending in ".txt"
+as wiki pages.
+
+Unlike other [[type/format]] plugins, no formatting of markup in
+txt files is done; the file contents is displayed to the user as-is,
+with html markup characters such as ">" escaped.
+
+The only exceptions are that [[WikiLinks|WikiLink]] and
+[[PreprocessorDirectives|PreprocessorDirective]] are still expanded by
+ikiwiki, and that, if the [[cpan URI::Find]] perl module is installed, URLs
+in the txt file are converted to hyperlinks.