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: tidied up documentation formatting and added missing statement

Browse Source
This commit is contained in:
Will Rossiter 2011-03-12 17:11:21 +13:00
parent b41ab528b7
commit a9e5a78037
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/en/index.md
View File

@ -18,19 +18,22 @@ you need to add the following to your applications _config.php file:
DocumentationSearch::enable(); DocumentationSearch::enable();
After adding that line you will also need to build the indexes of the search. You can run the following from your webbrowser or via sake After adding that line you will also need to build the indexes of the search. You can do this either via your web browser by accessing
http://yoursite.com/dev/tasks/RebuildLuceneDocsIndex?flush=1
Or rebuild it via sake. You will want to set this up as a cron job if your documentation search needs to be updated on the fly
sake dev/tasks/RebuildLuceneDocsIndex flush=1
### Using a URL other than /dev/docs/ ### Using a URL other than /dev/docs/
By default, the documentation is available in `dev/docs`. If you want it to live on the webroot instead of a subfolder, By default, the documentation is available in `dev/docs`. If you want it to live on the webroot instead of a subfolder,
add the following configuration to your `mysite/_config.php`: add the following configuration to your.
DocumentationViewer::set_link_base(''); DocumentationViewer::set_link_base('');
Director::addRules(1, array( Director::addRules(1, array(
'$Action' => 'DocumentationViewer', '$Action' => 'DocumentationViewer',
'' => 'DocumentationViewer' '' => 'DocumentationViewer'
)); ));