Template:Codesample

Template documentation

[view] [edit] [history] [purge]

This template augments a <syntaxhighlight> block with fancy colors and an optional title

Template parameters[Edit template data]

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Title	name	Title (name) of this code sample. Often a filename	String	suggested
Programming language	lang	Name of lexer to use for highlighting Default text Example shell-session	String	suggested
Code	code 1	Code sample to render	String	required
Highlighted lines	highlight	Line(s) in example to highlight. Comma separated list of line numbers	String	optional
Show line numbers	line	Enable line numbers for sample	Boolean	optional
Starting line number	start	Starting line number when line numbers are shown. Note: Does not effect line numbers used for highlights. Default 1	Number	optional
Color scheme	scheme	Color scheme to use. Default dark	String	optional
Copy button	copy	Show a "copy" button to copy the code to the clipboard	Boolean	optional

Examples

{{Codesample |echo "hello world!"}}	echo "hello world!"
{{Codesample |echo "hello world!" |lang=text |scheme=light}}	echo "hello world!"
{{Codesample |$ echo "hello world!" |lang=shell-session |scheme=dark}}	$ echo "hello world!"
{{Codesample |code=<nowiki>{{Codesample}}</nowiki> |lang=wikitext}}	{{Codesample}}
{{Codesample |name=ingress.yaml |lang=yaml |scheme=dark |line=1 |highlight=5,8 |code= --- apiVersion: networking.k8s.io/v1beta1 kind: Ingress metadata: name: foo-redirect namespace: tool-foo labels: name: foo-redirect annotations: kubernetes.io/ingress.class: nginx }}	ingress.yaml --- apiVersion: networking.k8s.io/v1beta1 kind: Ingress metadata: name: foo-redirect namespace: tool-foo labels: name: foo-redirect annotations: kubernetes.io/ingress.class: nginx
{{Codesample |name=metadata |lang=yaml |scheme=light |line=1 |start=5 |highlight=1,4 |code= name: foo-redirect namespace: tool-foo labels: name: foo-redirect annotations: kubernetes.io/ingress.class: nginx }}	metadata name: foo-redirect namespace: tool-foo labels: name: foo-redirect annotations: kubernetes.io/ingress.class: nginx
{{Codesample |echo "hello world!" |copy=}}	echo "hello world!"

Adding a new color scheme

The scheme=... parameter will load a css sub-page to add styles matching the Pygments markup definitions. The easiest way to introduce a new scheme is to export it from Pygments itself: pygmentize -f html -S $style -a .wt-codesample-${style}.

The above documentation is transcluded from Template:Codesample/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.