Go to file
Umherirrender b59f43ce8e Improve param docs
Change-Id: Ifcb9ed2fbbdc38e11dfcc44951314baed81f2410
2020-02-29 22:17:22 +01:00
.phan Migrate to new Phan 2019-03-02 13:43:16 +01:00
i18n Localisation updates from https://translatewiki.net. 2020-02-25 09:37:19 +01:00
includes Improve param docs 2020-02-29 22:17:22 +01:00
maintenance Use ::class for class name resolution 2019-03-03 02:22:47 +01:00
modules Syntaxhighlight: avoid double background 2020-02-09 20:18:50 +01:00
pygments Merge "Fix for create_pygmentize_bundle Python 3 compat" 2020-02-14 22:51:30 +00:00
tests/parser Syntaxhighlight: Classnames for the highlighted language 2020-02-18 20:13:53 +01:00
.eslintrc.json build: Update linters 2019-10-07 17:59:00 +01:00
.gitignore build: Upgrade eslint-config-wikimedia from 0.10.1 to 0.11.0 2019-04-03 16:26:40 -07:00
.gitreview Whoops, track not trace 2016-10-24 17:03:53 -07:00
.phpcs.xml Improve param docs 2020-02-29 22:17:22 +01:00
.stylelintrc.json Use json extension for .stylelintrc 2017-08-19 10:30:45 +02:00
CODE_OF_CONDUCT.md build: Updating mediawiki/phan-taint-check-plugin to 1.3.0 2018-08-19 16:54:29 +00:00
composer.json build: Updating composer dependencies 2020-01-30 06:48:31 +00:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Require the ability to shell out in extension.json 2019-04-13 19:25:33 +00:00
Gruntfile.js build: Updating npm dependencies 2020-01-13 05:13:39 +00:00
package-lock.json build: Updating npm dependencies 2020-02-21 03:07:03 +00:00
package.json build: Updating npm dependencies 2020-02-21 03:07:03 +00:00
README Update README to match pygments version 2019-10-18 00:59:01 +01:00
SyntaxHighlight.lexers.php Update pygments to 2.5.2 2020-02-13 15:28:32 -05:00

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 2.2.0 and
MediaWiki 1.33. To get releases of this extension compatible
with earlier versions of MediaWiki, visit:

    https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi

== Installation ==

Add this line to your LocalSettings.php:

    wfLoadExtension( 'SyntaxHighlight_GeSHi' );

By default, this extension will use a bundled copy of Pygments 2.2.0. 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.