tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 09:05:56 +00:00
Code Issues Projects Releases Wiki Activity

MINOR: updated documentation for permalinks

Browse Source
This commit is contained in:
Will Rossiter 2010-10-22 02:09:15 +00:00
parent 7546e9429a
commit 1a5c88b469
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
code/DocumentationPermalinks.php
View File

@ -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'
* ));
*
*

13
docs/en/Configuration-Options.md
View File

@ -20,3 +20,16 @@ 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.
## 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'
));