diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/features.mdwn | 11 | ||||
-rw-r--r-- | doc/index.mdwn | 4 | ||||
-rw-r--r-- | doc/plugins.mdwn | 2 | ||||
-rw-r--r-- | doc/plugins/mdwn.mdwn | 3 | ||||
-rw-r--r-- | doc/plugins/write.mdwn | 12 | ||||
-rw-r--r-- | doc/usage.mdwn | 3 |
6 files changed, 26 insertions, 9 deletions
diff --git a/doc/features.mdwn b/doc/features.mdwn index f116e00e3..0992130e5 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -26,6 +26,9 @@ Some of ikiwiki's features: provided by ikiwiki aside from regular markdown is the [[WikiLink]] and [[PreprocessorDirective]] + If you prefer to use some other markup language, ikiwiki allows others to + be added by [[plugins]]. + * support for other file types ikiwiki also supports files of any other type, including plain text, @@ -120,10 +123,10 @@ Some of ikiwiki's features: * [[Plugins]] Plugins can be used to add additional features to ikiwiki. The interface - is quite flexible, allowing plugins to register - [[PreProcessorDirective]]s, hook into [[CGI]] mode, and more. Ikiwiki's - backend RCS support is also pluggable, so support for new revision - control systems can be added to ikiwiki. + is quite flexible, allowing plugins to implement additional markup + languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode, + and more. Ikiwiki's backend RCS support is also pluggable, so support for + new revision control systems can be added to ikiwiki. * [[todo/utf8]] diff --git a/doc/index.mdwn b/doc/index.mdwn index c247cf744..3191d1c24 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,8 +1,8 @@ [[ikiwiki_logo|logo/ikiwiki.png]] ikiwiki is a **wiki compiler**. It converts wiki pages into html pages suitable for publishing on a website. Unlike a traditional -wiki, ikiwiki does not have its own means of storing page history or its own -markup language. Instead it can use [[Subversion]] (or [[Git]]) and [[MarkDown]]. +wiki, ikiwiki does not have its own means of storing page history. +Instead it can use [[Subversion]] (or [[Git]]). * [[News]] is a blog (built using ikiwiki) of news items about ikiwiki. It's the best way to find out when there's a new version to [[Download]]. diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 05b661f2b..d79a3bd3b 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,7 +1,7 @@ There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. -The [[inline]] and [[htmlscrubber]] plugins are enabled by default. +The [[mdwn]], [[inline]], and [[htmlscrubber]] plugins are enabled by default. To enable other plugins, use the `--plugin` switch described in [[usage]], or the equivalent `add_plugins` line in [[ikiwiki.setup]]. diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn new file mode 100644 index 000000000..d1b1254bf --- /dev/null +++ b/doc/plugins/mdwn.mdwn @@ -0,0 +1,3 @@ +This plugin, which is enabled by default, lets ikwiki convert files with +names ending in ".mwdn" to html. It uses the [[markdown]] minimal markup +language. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 515c4d90d..5be90efdf 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -55,7 +55,8 @@ Note that if the [[htmlscrubber]] is enabled, html in [[PreProcessorDirective]] output is sanitised, which may limit what your plugin can do. Also, the rest of the page content is not in html format at preprocessor time. Text output by a preprocessor directive will be passed -through markdown along with the rest of the page. +through markdown (or whatever engine is used to htmlize the page) along +with the rest of the page. # Other types of hooks @@ -79,6 +80,15 @@ Runs on the raw source of a page, before anything else touches it, and can make arbitrary changes. The function is passed named parameters `page` and `content` and should return the filtered content. +## htmlize + + IkiWiki::hook(type => "htmlize", id => "ext", call => \&filter); + +Runs on the raw source of a page and turns it into html. The id parameter +specifies the filename extension that a file must have to be htmlized using +this plugin. This is how you can add support for new and exciting markup +languages to ikiwiki. + ## pagetemplate IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); diff --git a/doc/usage.mdwn b/doc/usage.mdwn index deb94e415..6ff71056f 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -11,7 +11,8 @@ ikiwiki --setup configfile # DESCRIPTION `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from -`source` in the [[MarkDown]] language, and writes it out to `destination`. +`source` in the [[MarkDown]] language (or others), and writes it out to +`destination`. Note that most options can be shortened to single letters, and boolean flags such as --verbose can be negated with --no-verbose. |