RefractTrack Markdown Formatting: Difference between revisions
Nerdofepic (talk | contribs) No edit summary |
Nerdofepic (talk | contribs) No edit summary |
||
| Line 14: | Line 14: | ||
| A line starting with <nowiki>-</nowiki> or <nowiki>*</nowiki> || A bullet point | | A line starting with <nowiki>-</nowiki> or <nowiki>*</nowiki> || A bullet point | ||
|- | |- | ||
| A line starting with <nowiki>1.</nowiki> || A numbered list item | | A line starting with <nowiki>1.</nowiki> || A numbered list item | ||
|- | |- | ||
| Two spaces of indent || Nests a list item under the one above | | Two spaces of indent || Nests a list item under the one above | ||
|- | |- | ||
| Triple backticks around a block, with a language name || A code block, with | | Triple backticks around a block, with a language name || A code block, with color highlighting for that language (see below) | ||
|} | |} | ||
=== Supported code languages === | |||
Code blocks get color highlighting for a good range of the languages game teams actually use — just type one of the names below right after the opening triple backticks. Closely related languages share the same highlighting, so you don't need an exact match: any of the names in a row below works for that whole group. | |||
{| class="wikitable" | |||
! Languages !! Type any of these | |||
|- | |||
| C#, Java, C, C++ || <nowiki>csharp</nowiki>, <nowiki>cs</nowiki>, <nowiki>c#</nowiki>, <nowiki>java</nowiki>, <nowiki>c</nowiki>, <nowiki>cpp</nowiki>, <nowiki>c++</nowiki> | |||
|- | |||
| JSON, YAML, CSS || <nowiki>json</nowiki>, <nowiki>yaml</nowiki>, <nowiki>yml</nowiki>, <nowiki>css</nowiki> | |||
|- | |||
| JavaScript, TypeScript || <nowiki>javascript</nowiki>, <nowiki>js</nowiki>, <nowiki>typescript</nowiki>, <nowiki>ts</nowiki> | |||
|- | |||
| GDScript, Python || <nowiki>gdscript</nowiki>, <nowiki>gd</nowiki>, <nowiki>python</nowiki>, <nowiki>py</nowiki> | |||
|- | |||
| XML, HTML || <nowiki>xml</nowiki>, <nowiki>html</nowiki> | |||
|- | |||
| SQL || <nowiki>sql</nowiki> | |||
|} | |||
Any other (or no) language name still works fine — it just shows up as a plain, uncolored code block. | |||
=== Formatting a word or phrase === | === Formatting a word or phrase === | ||
Revision as of 00:07, 29 August 2026
Formatting Text
Anywhere you can type a longer note — task descriptions, comments, bug details — RefractTrack supports a small set of simple formatting shortcuts, so you can add structure without needing a rich-text toolbar. There's also a help button right next to these fields in the app if you ever need a quick reminder.
Structuring a block of text
| Type this | To get |
|---|---|
| A line starting with # | A heading |
| A line starting with ## | A smaller heading |
| A line starting with - or * | A bullet point |
| A line starting with 1. | A numbered list item |
| Two spaces of indent | Nests a list item under the one above |
| Triple backticks around a block, with a language name | A code block, with color highlighting for that language (see below) |
Supported code languages
Code blocks get color highlighting for a good range of the languages game teams actually use — just type one of the names below right after the opening triple backticks. Closely related languages share the same highlighting, so you don't need an exact match: any of the names in a row below works for that whole group.
| Languages | Type any of these |
|---|---|
| C#, Java, C, C++ | csharp, cs, c#, java, c, cpp, c++ |
| JSON, YAML, CSS | json, yaml, yml, css |
| JavaScript, TypeScript | javascript, js, typescript, ts |
| GDScript, Python | gdscript, gd, python, py |
| XML, HTML | xml, html |
| SQL | sql |
Any other (or no) language name still works fine — it just shows up as a plain, uncolored code block.
Formatting a word or phrase
| Type this | To get |
|---|---|
| **bold** | bold |
| *italic* | italic |
| ++underline++ | underlined text |
Live preview
As you type in a description or comment box, a live preview shows exactly how the formatted text will look — no guessing, and no need to save first to check.
Task codes link themselves
You never need to manually link to another task. Just type its code — like FE-12 — anywhere in a description or comment, and RefractTrack automatically turns it into a clickable link, as long as it's a real task you have permission to see.