How to format text with Markdown
What is Markdown?
Markdown is a text format that allows us to write text in a special way so that computers understand what should be a link, a heading, a table etc. without any other tools.
It is designed not only to be processed automatically by computers, but it is designed to look natural to humans, too.
Where can we use Markdown?
Markdown is used in many applications in the world and so knowledge of Markdown is very universal and not restricted to Contact Cache at all.
In Contact Cache, we can format notes and person’s summary with Markdown.
Basic Markdown formatting
How to format paragraphs?
To create a paragraph, simply leave a blank line before and after:
Paragraph 1 Paragraph 2 Paragraph 3
How to format text with bold and italics?
Paragraph with **bold text** and *text in italics*.
How to format headings?
To create a heading, use # symbol at the beginning of the text.
To create subheadings, simply add more symbols:
# Heading 1 ## Heading 2 ### Heading 3
How to format lists?
Use asterisks (* symbol) to create lists. It is possible to indend lists with two spaces.
* List item * List item * List item * list item * list item * List
How to format To-do lists?
To-do lists are lists that can symbolize whether a certain task has been done or not with [X] and [ ]:
* [X] Done task * [ ] Not done task * [X] Sub task done * [X] Sub task done * [ ] Sub task not done
How to format links?
The syntax for links has two parts. First we specify the name of the link using [link name], followed by the URL in parenthesis (http://example.com).
How to format tables?
Look at the intuitive examples below on how to format tables.
| First Header | Second Header | | ------------- | ------------- | | Content Cell | Content Cell | | Content Cell | Content Cell | | Example header | Second Header | | --- | --- | | Content 1 | content 2 | | content 3 | content 4 |
How to format citations?
We can mark a block of text as it was said by someone using > symbol.
Normal paragraph. > This is a text said by someone. Normal paragraph.
How to add a horizontal line?
If we need to devide sections of text with lines, we can use hyphen character - repeated three times to do so:
Normal paragraph. --- Normal paragraph.
How to format code?
This is for programmers, so don’t worry if you don’t know what this is about. Other people might not find this particularly useful.
To inline a short code within the text, use backticks before and after the code or use three backticks on the first and on the last lines to create a code block.
`Inline code` with backticks. Normal paragraph. ``` # Example code in Python print('Hello Python') ``` Normal paragraph.