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

Go to file

Ingo Schommer 255f5de162 BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags		2011-01-10 10:59:22 +00:00
code	BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags	2011-01-10 10:59:22 +00:00
css	MINOR: dl styles. PATCH via ajshort	2010-07-23 10:34:49 +00:00
docs/en	MINOR: updated documentation for permalinks	2010-10-22 02:09:15 +00:00
images	ENHANCEMENT: moved away from DebugView display / layout	2010-03-04 10:18:02 +00:00
javascript	BUGFIX: fixed url in header anchors. Added missing js link in the controller	2010-10-28 21:27:30 +00:00
templates	BUGFIX: fixed pagination of search results not loading on pages other than the first	2010-12-22 08:44:46 +00:00
tests	BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags	2011-01-10 10:59:22 +00:00
thirdparty/markdown	MINOR Moved markdown.php into thirdparty/markdown/	2011-01-10 10:59:20 +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)