diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ikiwiki.setup | 2 | ||||
| -rw-r--r-- | doc/plugins/map.mdwn | 16 |
2 files changed, 17 insertions, 1 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index a0ce5a468..678dece23 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -81,7 +81,7 @@ use IkiWiki::Setup::Standard { # To add plugins, list them here. #add_plugins => [qw{meta tag pagecount brokenlinks search smiley # wikitext camelcase pagestats htmltidy fortune - # sidebar}], + # sidebar map}], # If you want to disable any of the default plugins, list them here. #disable_plugins => [qw{inline htmlscrubber}], } diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn new file mode 100644 index 000000000..039ed559e --- /dev/null +++ b/doc/plugins/map.mdwn @@ -0,0 +1,16 @@ +This plugin generates a hierarchical page map for the wiki. Example usage: + + \[[map pages="* and !blog/*" maxdepth=2]] + +If the pages to include are not specified, all pages (and other files) in +the wiki are mapped. If the maxdepth parameter is passed, only pages nested +less than that many levels deep will be included in the map. + +This plugin is included in ikiwiki, but is not enabled by default. + +If this plugin is enabled, here is a page map for the plugins section +of this wiki: + +[[map pages="plugins or plugins/*" maxdepth=3]] + +[[tag type/meta]] |