tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 11:05:56 +02:00
Code Issues Projects Releases Wiki Activity
95 Commits 3 Branches 20 Tags 1.4 MiB
PHP 74.9%
CSS 15.8%
Scheme 5.7%
JavaScript 3.6%
50de5f23ef
Go to file
Will Rossiter 50de5f23ef MINOR: removed link to ssdocs project from module.
2011-03-12 17:12:48 +13:00
code MINOR: changed theme to a darker one to help with readability 2011-03-07 09:55:29 +13:00
css MINOR: dl styles. PATCH via ajshort 2010-07-23 10:34:49 +00:00
docs MINOR: tidied up documentation formatting and added missing statement 2011-03-12 17:11:21 +13:00
images ENHANCEMENT: moved away from DebugView display / layout 2010-03-04 10:18:02 +00:00
javascript MINOR Removing SyntaxHighlighter toolbar, it destroys the layout whitespace a bit 2011-01-12 21:32:00 +00:00
lang FEATURE: implemented initial cut of open search output and description functionality. 2011-01-21 04:10:41 +00:00
templates MINOR: removed link to ssdocs project from module. 2011-03-12 17:12:48 +13:00
tests MINOR temporarily disabled DocumentationViewerTest->testLocationExists(), it fails when not run through phhunit binary for some reason... 2011-02-01 20:41:45 +00:00
thirdparty BUGFIX: added missing _manifest_exclude files from thirdparty and docs. 2011-03-12 17:10:48 +13:00
_config.php APICHANGE: refactored DocumentationSearch to go back to a simple class rather than a controller. All requests interfacing with the search should go through DocumentationViewer. APICHANGE: migrated DocumentationSearch::opensearch() to its own controller. BUGFIX: declare default meta_data in the function rather than using the api to prevent inclusion order issues 2011-02-11 01:29:25 +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 MINOR Documentation 2011-01-17 06:00:16 +00:00

README.md

Documentation Viewer Module

Maintainer Contact

Requirements

  • SilverStripe 2.4

Summary

Reads markdown documentation files from the /docs/ folder in . 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.

Search

Search needs to be indexed manually with dev/tasks/RebuildLuceneDocsIndex.

Syntax Highlighting

The custom Markdown parser can render custom prefixes for code blocks, and render it via a javascript syntax highlighter.

In:

:::php
my sourcecode

Out:

<pre class="brush: php">
my sourcecode
</pre>

To include the syntax highlighter source, add the following to your DocumentationViewer->init():

Requirements::javascript(THIRDPARTY_DIR .'/jquery/jquery.js');
Requirements::javascript('sapphiredocs/thirdparty/syntaxhighlighter/scripts/shCore.js');
Requirements::javascript('sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushJScript.js');
Requirements::javascript('sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushPHP.js');
Requirements::javascript('sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushXML.js');
// ... any additional syntaxes you want to support
Requirements::combine_files(
	'syntaxhighlighter.js',
	array(
		'sapphiredocs/thirdparty/syntaxhighlighter/scripts/shCore.js',
		'sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushJScript.js',
		'sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushPHP.js',
		'sapphiredocs/thirdparty/syntaxhighlighter/scripts/shBrushXML.js'
	)
);

Requirements::javascript('sapphiredocs/javascript/DocumentationViewer.js');

// css
Requirements::css('sapphiredocs/thirdparty/syntaxhighlighter/styles/shCore.css');
Requirements::css('sapphiredocs/thirdparty/syntaxhighlighter/styles/shCoreDefault.css');
Requirements::css('sapphiredocs/thirdparty/syntaxhighlighter/styles/shThemeRDark.css');

You can overload the DocumentationViewer class and add a custom route through Director::addRule() if you prefer not to modify the module file.