RefractTrack Markdown Formatting: Difference between revisions
Nerdofepic (talk | contribs) No edit summary |
Nerdofepic (talk | contribs) No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
! Type this !! To get | ! Type this !! To get | ||
|- | |- | ||
| A line starting with | | A line starting with # || A heading | ||
|- | |- | ||
| A line starting with | | A line starting with ## || A smaller heading | ||
|- | |- | ||
| A line starting with | | A line starting with - or * || A bullet point | ||
|- | |- | ||
| A line starting with | | A line starting with 1. || 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++ || 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 === | === Formatting a word or phrase === | ||
| Line 39: | Line 61: | ||
=== Task codes link themselves === | === 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. | 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. You can see this in action in the description on the [[RefractTrack_Tasks|Tasks]] page's example screenshot. | ||
=== Related pages === | === Related pages === | ||
| Line 45: | Line 67: | ||
* [[RefractTrack_Tasks|Tasks]] | * [[RefractTrack_Tasks|Tasks]] | ||
* [[RefractTrack_Comments_and_Activity_Log|Comments and Activity]] | * [[RefractTrack_Comments_and_Activity_Log|Comments and Activity]] | ||
[[Category:RefractTrack]] | |||
Latest revision as of 22:46, 11 September 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. You can see this in action in the description on the Tasks page's example screenshot.