tonyair/doc.silverstripe.org
1
0
Fork 0
mirror of https://github.com/silverstripe/doc.silverstripe.org synced 2024-10-22 17:05:50 +02:00
Code Issues Projects Releases Wiki Activity
52507bd063
doc.silverstripe.org/sapphiredocs
History
Will Rossiter f397d494e0 MINOR: avoid wrapping api links in code tags as parser cannot handle it. 
git-svn-id: http://svn.silverstripe.com/projects/ss2doc/branches/v2@118563 467b73ca-7a2a-4603-9d3b-597d59a354a9
2011-05-05 23:55:59 +00:00
..
code MINOR: avoid wrapping api links in code tags as parser cannot handle it. 2011-05-05 23:55:59 +00:00
css MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
docs MINOR Updated piston dependency 2011-04-10 20:11:27 +00:00
images MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
javascript MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
lang MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
templates MINOR: updated ssdoc 2011-04-29 02:40:15 +00:00
tests Updated test to match new method 2011-04-29 05:08:06 +00:00
thirdparty MINOR Updated piston dependency 2011-04-10 20:11:27 +00:00
_config.php MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
.piston.yml MINOR: updated ssdoc 2011-04-29 02:40:15 +00:00
LICENSE MINOR Readding sapphiredocs 2011-02-14 22:06:22 +00:00
README.md MINOR Readding sapphiredocs 2011-02-14 22:06:22 +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.