diff --git a/code/DocumentationPermalinks.php b/code/DocumentationPermalinks.php index f99d540..9cb1a2d 100644 --- a/code/DocumentationPermalinks.php +++ b/code/DocumentationPermalinks.php @@ -20,7 +20,7 @@ class DocumentationPermalinks { * Add a mapping of nice short permalinks to a full long path * * DocumentationPermalinks::add(array( - * 'debugging' => 'sapphire/topics/debugging.md' + * 'debugging' => 'current/en/sapphire/topics/debugging' * )); * * diff --git a/docs/en/Configuration-Options.md b/docs/en/Configuration-Options.md index 16a5be2..90fff28 100644 --- a/docs/en/Configuration-Options.md +++ b/docs/en/Configuration-Options.md @@ -19,4 +19,17 @@ to load a module outside a documentation path). Unregister a module (removes from documentation list). You can specify the module, the version and the lang. If no version is specified then all folders of that lang are removed. If you do -not specify a version or lang the whole module will be removed from the documentation. \ No newline at end of file +not specify a version or lang the whole module will be removed from the documentation. + +## Permalinks + +You can set short names for longer urls so they are easier to remember. Set the following in your mysite/_config.php file: + + DocumentationPermalinks::add(array( + 'debugging' => 'current/en/sapphire/topics/debugging', + 'templates' => 'current/en/sapphire/topics/templates' + )); + + + + \ No newline at end of file