silverstripe-docsviewer/README.md

# Documentation Viewer Module

[![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-docsviewer.png?branch=master)](http://travis-ci.org/silverstripe/silverstripe-docsviewer)

## Maintainer Contact

* Will Rossiter (Nickname: willr, wrossiter) 
 <will@fullscreen.io>

## Requirements

* SilverStripe 3.0

## Summary

Reads text files from a given list of folders from your installation and 
provides a web interface for viewing. 

To read documentation go to yoursite.com/dev/docs/

For more documentation on how to use the module please read /docs/Writing-Documentation.md 
(or via this in /dev/docs/sapphiredocs/Writing-Documentation in your webbrowser)

**Note** This module assumes you are using numeric values for your versions.
FEATURE: initial commit of sapphire documentation viewer module. Parses each module with a docs folder and generates formatted trees for each. Parses single markdown files for display 2010-03-04 05:39:02 +01:00			`# Documentation Viewer Module`

Travis support 2013-03-29 09:38:02 +01:00			`[![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-docsviewer.png?branch=master)](http://travis-ci.org/silverstripe/silverstripe-docsviewer)`

ENHANCEMENT: included zend/search/lucene with the module to avoid including the entire lucene module. ENHANCEMENT: added hourly task as well as buildtask for dealing with cron updates. MINOR: updated documentation 2011-01-11 02:35:59 +01:00			`## Maintainer Contact`

			`* Will Rossiter (Nickname: willr, wrossiter)`
MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts 2012-04-08 11:23:49 +02:00			`<will@fullscreen.io>`
FEATURE: initial commit of sapphire documentation viewer module. Parses each module with a docs folder and generates formatted trees for each. Parses single markdown files for display 2010-03-04 05:39:02 +01:00
			`## Requirements`
ENHANCEMENT: included zend/search/lucene with the module to avoid including the entire lucene module. ENHANCEMENT: added hourly task as well as buildtask for dealing with cron updates. MINOR: updated documentation 2011-01-11 02:35:59 +01:00
BUGFIX: upgrade module to fit 3.0 api. 2012-04-14 07:00:22 +02:00			`* SilverStripe 3.0`
FEATURE: initial commit of sapphire documentation viewer module. Parses each module with a docs folder and generates formatted trees for each. Parses single markdown files for display 2010-03-04 05:39:02 +01:00
			`## Summary`

MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts 2012-04-08 11:23:49 +02:00			`Reads text files from a given list of folders from your installation and`
			`provides a web interface for viewing.`

			`To read documentation go to yoursite.com/dev/docs/`
FEATURE: initial commit of sapphire documentation viewer module. Parses each module with a docs folder and generates formatted trees for each. Parses single markdown files for display 2010-03-04 05:39:02 +01:00
ENHANCEMENT: included zend/search/lucene with the module to avoid including the entire lucene module. ENHANCEMENT: added hourly task as well as buildtask for dealing with cron updates. MINOR: updated documentation 2011-01-11 02:35:59 +01:00			`For more documentation on how to use the module please read /docs/Writing-Documentation.md`
			`(or via this in /dev/docs/sapphiredocs/Writing-Documentation in your webbrowser)`
MINOR Enabled markdown code block parsing logic, README for syntax highlighting, loading syntaxhighlighter JS and CSS 2011-01-10 11:59:31 +01:00
ENHANCEMENT: use urls in the format module/lang/version rather than version first. Tweaks to the parser to prevent infinite loops 2011-01-14 02:03:46 +01:00			`Note This module assumes you are using numeric values for your versions.`