mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
synced 2024-11-14 18:15:57 +00:00
987187935c
This avoids having an extension function, which runs on every request, regardless of whether it uses syntax highlighting or not. Change-Id: I890348b73af956819300cce64d0672dcdb209c19 |
||
---|---|---|
i18n | ||
maintenance | ||
modules | ||
pygments | ||
tests | ||
.eslintrc.json | ||
.gitignore | ||
.gitreview | ||
.stylelintrc | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
COPYING | ||
extension.json | ||
Gruntfile.js | ||
package.json | ||
phpcs.xml | ||
README | ||
ResourceLoaderSyntaxHighlightVisualEditorModule.php | ||
SyntaxHighlight.ace.php | ||
SyntaxHighlight.class.php | ||
SyntaxHighlight.GeSHi.compat.php | ||
SyntaxHighlight.GeSHi.php | ||
SyntaxHighlight.lexers.php | ||
SyntaxHighlight_GeSHi.php |
This extension allows source code to be syntax highlighted on the wiki pages. This README file might be out of date, have a look at the extension page for updated informations: https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi == Requirements == This version of the extension has been tested with Pygments 1.6, 2.0.2 and MediaWiki 1.25 as of 2015-06-19. To get releases of this extension compatible with earlier versions of MediaWiki, visit: https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi == Installation == First, you will need to ensure that this extension's Composer-managed dependencies are available. In the extension directory, run 'composer update'. Next, Add this line to your LocalSettings.php: wfLoadExtension( 'SyntaxHighlight_GeSHi' ); By default, this extension will use a bundled copy of Pygments 2.0.2. If you would like to use a different copy of the library, you can set $wgPygmentizePath to point to the path to the 'pygmentize' binary. == Usage == On the wiki page, you can now use "source" elements: <source lang="php"> <?php v = "string"; // sample initialization ?> html text <?php echo v; // end of php code ?> </source> == Parameters == For details information of these parameters, see the documentation of Pygments' HtmlFormatter at <http://pygments.org/docs/formatters/#HtmlFormatter>. * lang; Defines the language. * line; Corresponds to linenos="inline" option. * start; Corresponds to linenostart opion. * enclose; If set to "none", corresponds to the nowrap=1 option. * inline; Corresponds to the nowrap=1 option. * highlight; Corresponds to hl_lines option (comma separated). == Note == Pygments is generous about creating HTML elements: highlighting large blocks of code can easily generate enough of them to crash a browser. As a guard, syntax highlighting is turned off for code fragments larger than 100 kB.