YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Getting Started
  2. YouTrack Wiki Syntax

YouTrack Wiki Syntax

Last modified: 17 December 2019

With YouTrack, you can use a special wiki markup to format text in issue descriptions and comments. This markup also lets you link to other issues and external resources, highlight code, and insert tables.

Since YouTrack introduced Markdown support, Markdown is the recommended option for formatting text in YouTrack. YouTrack Wiki Markup is still supported, but will be deprecated and phased out over time. To support users during this transitional period, we provide an option to toggle between Markdown and YouTrack Wiki on a per-user basis. This option is visible wherever you have the ability to apply formatting to text input.

Hints for commonly-used formatting options are displayed below the Description input field for new issues.

Wiki formatting description

The same options are displayed below the input field for comments.

To see a complete list of formatting options, click the YouTrack Wiki link to open the syntax list, then click the help icon. This opens the the YouTrack Markup Reference page in your browser.

Youtrack wiki markup reference

The YouTrack Markup Reference page provides a sandbox. Use the sandbox to preview the formatted output. When the text is formatted to your liking, copy the contents of the sandbox and paste it into the issue description or comment.

Code Highlighting

YouTrack uses the Google Code Prettify library to highlight code. This lets YouTrack apply standard code highlights to a range of programming languages. To highlight code, set the text in {code} tags.

The following languages are recognized and highlighted automatically: C, C++, C#, Java, JavaScript, Perl, Python, Ruby, and SH.

To highlight code in other languages, set the lang=<langname> parameter. The following languages are supported with this parameter: apollo (AGC/AEA Assembly Language), css, hs (Haskell), lisp, lua, ml, scala, sql, vb, vhdl, wiki, and yaml.

The following example shows text in a comment that is specified as Haskell code. The preview pane displays the code with highlights.

Wiki markup haskell

Stack Traces

YouTrack Wiki syntax automatically recognizes and formats Java and C# stack traces that are inserted into an issue description or comment.

Java stack trace

When the stack trace is formatted, references to source code and other issues are set as links.

If you have installed the YouTrack Integration Plugin, you can click these links to open the target reference in your integrated development environment. This feature is also supported by the the TeamCity Integration plugin.