Go to file
Hasley 848de8b747 README: Fix a typo.
Change-Id: I05db2f1c8e6929be2bd87ee5c07b11454450b189
2020-06-22 23:35:13 +00:00
.phan Migrate to new Phan 2019-03-02 13:43:16 +01:00
i18n Localisation updates from https://translatewiki.net. 2020-06-18 08:38:40 +02:00
includes Merge "Pass associative array to Sanitizer::validateAttributes" 2020-06-12 02:44:29 +00:00
maintenance Use Maintenance::fatalError instead of exception in maintenance script 2020-06-02 20:25:39 +00: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 Add tracking categories when deprecated syntax is used 2020-04-09 19:18:32 +00: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
.phpcs.xml build: Updating dependencies 2020-04-22 20:20:00 +00: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 mediawiki/minus-x to 1.1.0 2020-06-10 07:29:10 +00:00
COPYING
extension.json Merge "Pass associative array to Sanitizer::validateAttributes" 2020-06-12 02:44:29 +00:00
Gruntfile.js build: Updating npm dependencies 2020-01-13 05:13:39 +00:00
package-lock.json build: Updating dependencies 2020-04-22 20:20:00 +00:00
package.json build: Updating dependencies 2020-04-22 20:20:00 +00:00
README README: Fix a typo. 2020-06-22 23:35:13 +00: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 option.
* 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.