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

Go to file

Will Rossiter e11837763b MINOR: added space between commas to allow line breaks		2010-06-03 03:02:44 +00:00
code	MINOR: added space between commas to allow line breaks	2010-06-03 03:02:44 +00:00
css	MINOR: tweaks to the styles to tidy it up	2010-06-03 03:00:23 +00:00
docs	APICHANGE: upon the popular vote /docs/ for documentation rather than /doc/	2010-04-11 04:02:25 +00:00
images	ENHANCEMENT: moved away from DebugView display / layout	2010-03-04 10:18:02 +00:00
javascript	ENHANCEMENT: coverted sapphiredocs to use SSViewer instead of DevelopmentAdmin templating. BUGFIX: fixed anchors generated in the table of contents.	2010-04-11 07:25:26 +00:00
templates	ENHANCEMENT: coverted sapphiredocs to use SSViewer instead of DevelopmentAdmin templating. BUGFIX: fixed anchors generated in the table of contents.	2010-04-11 07:25:26 +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)