mirror of
https://github.com/silverstripe/silverstripe-docsviewer
synced 2024-10-22 11:05:56 +02:00
44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
|
# Syntax Highlighting
|
||
|
|
|
||
|
|
The custom Markdown parser can render custom prefixes for code blocks, and
|
||
|
|
render it via a [javascript syntax highlighter](http://alexgorbatchev.com/SyntaxHighlighter).
|
||
|
|
|
||
|
|
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.
|