For the complete documentation index, see llms.txt
For the complete documentation index, see llms.txt
Zinc
Help center
How to Use Markdown on an Enhanced Candidate Note
To enable the **Enhanced candidate note** option, please speak to your Account Manager to turn this on first.
Once enabled, you will find you have the guidance below when creating a new package or when you edit a package, you will see this preview area. If you have existing packages before this change was made, the text won't be affected until you make an edit using the Markdown syntax formatting.
On either the package editor or initial package set up, we provide you with a small preview to show you what it looks like to the candidate on the platform. Please note, on emails it can adjust the spacing slightly so it might not be identical.
You can use Markdown syntax in the candidate note to create lists, use bold and italic text, and utilise other features of Markdown formatting.
To make it easier for you, we've provided guidance here on how to use the Markdown formatting.
## Styling text
### Bold
To bold text, add two asterisks before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.
**Example**
This is **bold text**
### Italic
To italicise text, add one asterisk before and after a word or phrase. To italicise the middle of a word for emphasis, add one asterisk without spaces around the letters.
**Example**
This is *italic text*
### All bold and italic
To emphasise text with bold and italics at the same time, add three asterisks before and after a word or phrase. To bold and italicise the word in a sentence for emphasis, add three asterisks without spaces around the specific word.
**Example**
This is ***bold and italic text***
### Bold and nested italic
To emphasise the text as bold, add two asterisks before and after the phrase. To italicise a word for emphasis, add one underscore without spaces around the specific word.
**Example**
**This text is _very_ important**
### Underline
To underline the text, add <ins> before and </ins> after the phrase. To underline one word for emphasis, add <ins> </ins> without spaces around the specific word.
**Example**
This is an <ins>underlined</ins> text
## Line breaks
To create a line break, you can add **< br>** or **two spaces** at the end of the first line to create a new line.
You can also add more if you need to for creating larger spaces or a new paragraph.
## Headings
To create a heading, add one to six `#` symbols before your heading text. The number of `#` you use will determine the hierarchy level and typeface size of the heading. For compatibility, always put a space between the number signs and the heading name. You should also put blank lines before and after a heading for compatibility.
**For example**
\# A first-level heading
\#\# A second-level heading
\#\#\# A third-level heading
## Lists
You can organise items into ordered and unordered lists.
### Unordered lists
You can make an unordered list by preceding one or more lines of text with `-`, `*`, or `+`. Just remember to put a space in between the symbol and the word.
### Ordered lists
To order your list, precede each line with a number like below. Again, put a space in between the period and the word. Please don't use a parenthesis after the number as this won't work.
1. James Madison
2. James Monroe
3. John Quincy Adams
## Links
We don't recommend using links in the candidate note as it is better to provide all the information needed in the candidate note with text to keep candidates on Zinc instead of external pages in the checking process.
However, if you need this, you can create an inline link by wrapping link text in brackets `[]` and then wrapping the URL in parentheses `()`.
## Emojis
You can add emoji to your writing by using your device's emoji picker to add them into the note.
## Lines
If you want to add a line, add `---` in between two paragraphs where needed to break up text.
## Example note
To show you all the formatting put together, you can see our example candidate note below with our Markdown formatting and our final candidate note.
Now you know all the tips and tricks to make your very own Enhanced candidate note. Once you have your note, click **Save check package** or **Continue** at the bottom of the screen to save this note and any other edits to your package to complete the set up process and start requesting checks.
If you do need any further assistance, please let our Account Management team know at accountmanagement@zincwork.com
