When you create a wiki page using Markdown, the following commonly used syntax will generate the listed effects.
| Syntax | Effect |
|---|---|
| **bold text** | bold text |
| _italicized text_ | italicized text |
| ~~strikethrough~~ | |
| - Three Equivalent Symbols + For Indicating Bullet * List Items |
|
| - Indent Two Spaces For - Each Level of - Nested Bullet |
|
| 1. create a 2. numbered list 3. of items |
|
| [link to labkey](https://www.labkey.com) | link to labkey |
| [link with hover](https://www.labkey.com "Hover Text") | link with hover |
| `inline code` | inline code is surrounded by backticks |
|
``` Block of code with ``` on surrounding lines as "fences" ``` |
Block of code with ``` (backticks) on surrounding lines as "fences" |
The Markdown implementation LabKey uses requires a space between the # symbol(s) and heading text.
| Syntax | Effect |
|---|---|
| # Title Heading | Title Heading (h1) |
| ## Main Heading | Main Heading (h2) |
| ### Sub Heading | Sub Heading (h3) |
| #### Minor Heading | Minor Heading (h4) |
| ##### Inner Heading | Inner Heading (h5) |
LabKey uses the commonmark-java Markdown implementation with the Heading anchor extension which automatically turns any heading into a page anchor.
The anchors created will be the heading text, all lower case and substituting "-" for spaces. For example, this heading:
### My Section Heading
Would be referenced in a markdown link as:
[on page link text](#my-section-heading) [cross page link text](./wiki-page.view?name=anotherPage#my-section-heading)
If your Markdown source includes any HTML, correctly formatted comments will be passed through as-is, i.e. the comment will not be shown. Other HTML will be encoded and rendered as text to the user.
| previousnext |
| expand allcollapse all |
