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

Go to file

Will Rossiter 7546e9429a BUGFIX: fixed homepage storing current as module		2010-10-22 01:52:35 +00:00
code	BUGFIX: fixed homepage storing current as module	2010-10-22 01:52:35 +00:00
css	MINOR: dl styles. PATCH via ajshort	2010-07-23 10:34:49 +00:00
docs/en	BUGFIX Allow using module on root URL space	2010-08-01 04:46:41 +00:00
images	ENHANCEMENT: moved away from DebugView display / layout	2010-03-04 10:18:02 +00:00
javascript	BUGFIX: Fix anchor link URIs in the table of content nav	2010-09-05 03:17:42 +00:00
templates	MINOR Removed debug code	2010-08-01 04:46:28 +00:00
tests	APICHANGE: refactored names and structure of handleAction rerouting to a) be more clearer and b) to allow permalinks	2010-10-22 01:10:04 +00:00
thirdparty	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 04:39:02 +00:00
_config.php	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 04:39:02 +00:00
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 04:39:02 +00:00
README.md	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 04:39:02 +00:00

README.md

Documentation Viewer Module

Maintainer Content

Will Rossiter (Nickname: willr, wrossiter) will@silverstripe.com

Requirements

Tested on 2.4 and trunk

Summary

Read nested documentation files from the /docs/ folder in modules. To read documentation go to yoursite.com/dev/docs/.

It is likely this will be integrated into the core in future versions once it is polished.

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