silverstripe-docsviewer/README.md

# Documentation Viewer Module

## ABANDONED

This package is abandoned. See [silverstripe/doc.silverstripe.org](https://github.com/silverstripe/doc.silverstripe.org) instead.

[![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

These are pulled in via Composer.

* SilverStripe 3.1
* [Parsedown](http://parsedown.org/) and Parsedown Extra.

## Summary

Reads markdown files from a given list of folders from your installation and
provides a web interface for viewing the documentation. Ideal for providing
documentation alongside your module or project code.

A variation of this module powers the main SilverStripe developer documentation
and the user help websites.

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

## Installation

	composer require "silverstripe/docsviewer" "dev-master"

## Usage

After installing the files via composer, rebuild the SilverStripe database..

	sake dev/build

Then start by viewing the documentation at `yoursite.com/dev/docs`.

If something isn't working, you can run the dev task at `yoursite.com/dev/tasks/CheckDocsSourcesTask`
to automatically check for configuration or source file errors.

Out of the box the module will display the documentation files that have been
bundled into any of your installed modules. To configure what is shown in the
documentation viewer see the detailed [documentation](docs/en/configuration.md).

For more information about how to use the module see each of the documentation

	* [Configuration](docs/en/configuration.md)
	* [Markdown Syntax](docs/en/markdown.md)
	* [Syntax Highlighting](docs/en/syntax-highlighting.md)
	* [Publishing Static Files](docs/en/statichtml.md)

## License

See LICENSE
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`

Mark as abandoned 2023-03-16 22:26:53 +01:00			`## ABANDONED`

			`This package is abandoned. See [silverstripe/doc.silverstripe.org](https://github.com/silverstripe/doc.silverstripe.org) instead.`

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`

ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			`* 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
Update README.md 2015-01-07 02:09:13 +01:00			`These are pulled in via Composer.`

NEW: Add static publisher option 2014-01-14 08:41:59 +01:00			`* SilverStripe 3.1`
Update README.md 2015-01-07 02:09:13 +01:00			`* [Parsedown](http://parsedown.org/) and Parsedown Extra.`
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`

ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			`Reads markdown files from a given list of folders from your installation and`
			`provides a web interface for viewing the documentation. Ideal for providing`
			`documentation alongside your module or project code.`
MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts 2012-04-08 11:23:49 +02:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`A variation of this module powers the main SilverStripe developer documentation`
			`and the user help websites.`
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 A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			`For more documentation on how to use the module please read /docs/Writing-Documentation.md`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00			`(or via this in /dev/docs/docsviewer/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
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`## Installation`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`composer require "silverstripe/docsviewer" "dev-master"`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`## Usage`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`After installing the files via composer, rebuild the SilverStripe database..`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`sake dev/build`
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			Then start by viewing the documentation at `yoursite.com/dev/docs`.
NEW: Add static publisher option 2014-01-14 08:41:59 +01:00
ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			If something isn't working, you can run the dev task at `yoursite.com/dev/tasks/CheckDocsSourcesTask`
			`to automatically check for configuration or source file errors.`

Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`Out of the box the module will display the documentation files that have been`
ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			`bundled into any of your installed modules. To configure what is shown in the`
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00			`documentation viewer see the detailed [documentation](docs/en/configuration.md).`

ENHANCEMENT A missing sources dir will simply disable that repo with a warning, rather than fatally erroring 2016-06-21 07:42:13 +02:00			`For more information about how to use the module see each of the documentation`
Overhaul of module to use DocumentationManifest This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction(). 2014-09-07 01:26:12 +02:00
			`* [Configuration](docs/en/configuration.md)`
			`* [Markdown Syntax](docs/en/markdown.md)`
			`* [Syntax Highlighting](docs/en/syntax-highlighting.md)`
			`* [Publishing Static Files](docs/en/statichtml.md)`

			`## License`

Update README.md 2015-01-07 02:09:13 +01:00			`See LICENSE`