silverstripe-docsviewer/docs/en/index.md

# Sapphire Documentation Module

This module has been developed to read and display content from markdown files in webbrowser. It is an easy
way to bundle end user documentation within a SilverStripe installation.

See [Writing Documentation](dev/docs/en/sapphiredocs/writing-documentation) for more information on how to write markdown files which
are available here. 

To include your docs file here create a __docs/en/index.md__ file. You can also include custom paths and versions. To configure the documentation system the configuration information is available on the [Configurations](dev/docs/en/sapphiredocs/configuration-options)
page.

## Setup

### Enabling Search

The module provides automatic search functionality via [Lucene Search](http://lucene.apache.org/java/docs/index.html). To enable search
you need to add the following to your applications _config.php file:

	DocumentationSearch::enable();
	
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/

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.

	DocumentationViewer::set_link_base('');
	Director::addRules(1, array(
		'$Action' => 'DocumentationViewer',
		'' => 'DocumentationViewer'
	));