mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 11:05:56 +02:00

Go to file

Will Rossiter dd84574b8d BUGFIX: upgrade module to fit 3.0 api.		2012-04-14 17:00:22 +12:00
code	BUGFIX: upgrade module to fit 3.0 api.	2012-04-14 17:00:22 +12:00
css	MINOR: include own syntax highlighting theme for ssdoc.	2011-08-11 13:32:09 +12:00
docs	MINOR: rename from docviewer to docsviewer	2012-04-08 21:36:16 +12:00
images	ENHANCEMENT: moved away from DebugView display / layout	2010-03-04 10:18:02 +00:00
javascript	MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts	2012-04-08 21:23:49 +12:00
lang	FEATURE: implemented initial cut of open search output and description functionality.	2011-01-21 04:10:41 +00:00
templates	MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts	2012-04-08 21:23:49 +12:00
tests	BUGFIX: upgrade module to fit 3.0 api.	2012-04-14 17:00:22 +12:00
thirdparty	ENHANCEMENT: rolled out basic versioning support.	2011-07-01 13:19:35 +12:00
_config.php	BUGFIX: upgrade module to fit 3.0 api.	2012-04-14 17:00:22 +12:00
.gitignore	MINOR: ignore ds store files	2012-04-08 21:19:29 +12:00
LICENSE	ENHANCEMENT: rolled out basic versioning support.	2011-07-01 13:19:35 +12:00
README.md	BUGFIX: upgrade module to fit 3.0 api.	2012-04-14 17:00:22 +12:00

README.md

Documentation Viewer Module

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.