Markdown: Difference between revisions
No edit summary |
|||
| Line 105: | Line 105: | ||
|<span style="color:red;">Red Text</span> | |<span style="color:red;">Red Text</span> | ||
|Colours can be referenced by name (see [[wikipedia:Web_colors#Extended_colors|X11 color names]]) or by their hexadecimal RGB representation, e.g. <code>~[Red](color:#ff0000)</code>. It is expected that explicit colours would be used sparingly in practice. | |Colours can be referenced by name (see [[wikipedia:Web_colors#Extended_colors|X11 color names]]) or by their hexadecimal RGB representation, e.g. <code>~[Red](color:#ff0000)</code>. It is expected that explicit colours would be used sparingly in practice. | ||
|- | |||
|<code>~[Red Text](c:red)</code> | |||
|<span style="color:red;">Red Text</span> | |||
|The "c:" prefix denotes the text colour. | |||
|- | |||
|<code>~[Green Highlight](h:lime)</code> | |||
|<span style="background-color:lime;">Green Highlight</span> | |||
|The "h:" prefix denotes the highlight colour. | |||
|- | |||
|<code>~[Multi](c:red,h:lime)</code> | |||
|<span style="color:red;background-color:lime;">Multi</span> | |||
|} | |} | ||
Revision as of 09:55, 18 July 2023
Markdown is a lightweight markup language for creating formatted text.
It is used in ContactsLaw for notes (associated with contacts, matters, etc) as well as in document templates.
One of the principal reasons for using Markdown (as opposed to other representations, such as Rich Text Format or HTML) is that it separates markup (paragraphs, lists, headings, etc) from style (colours, fonts, etc). This means that the same content can be displayed in different ways without affecting its semantics. This is particularly useful in document production as the author of the template does not need to be aware of any business-specific branding or design and, indeed, these can be altered freely without affecting content specifications.
The Desktop App provides a WYSIWYG editor, such that users do not need to learn the Markdown syntax. The Web App, however, requires Markdown to be entered directly, displaying a separate preview of the formatting.
Standard Features
ContactsLaw supports the following standard Markdown features:
| Markdown | Formatting | Remarks |
|---|---|---|
**Bold**
|
Bold | |
*Italic*_Italic_
|
Italic | |
***Bold and Italic***
|
Bold and Italic | |
# Heading 1
|
Heading 1 |
|
## Heading 2
|
Heading 2 |
|
### Heading 3
|
Heading 3 |
|
#### Heading 4
|
Heading 4 |
Depending on the destination, up to 6 heading styles may be available. |
1. Ordered List
|
|
List items are automatically numbered, so you need only place a '1' beside each. |
- Unordered List
|
|
|
[Hyperlink](https://google.com)
|
Hyperlink | |
<https://google.com>
|
https://google.com | |
<name@email.com>
|
name@email.com | Automatically creates a "mailto:" link. |
`Code Span`
|
Code Span
|
Insignificant whitespace is preserved (this is not usually the case). |
---
|
Horizontal line/separator. |
Extended Features
ContactsLaw adds the following extended features:
| Markdown | Formatting | Remarks |
|---|---|---|
__Underline__
|
Underline | Not normally used in Markdown because it is easily confused with a hyperlink. |
~~Strikethrough~~
|
||
==Highlight==
|
Highlight | Uses the default highlight colour. |
:smile:
|
😄 | A range of emoji are supported. |
~[Red Text](red)
|
Red Text | Colours can be referenced by name (see X11 color names) or by their hexadecimal RGB representation, e.g. ~[Red](color:#ff0000). It is expected that explicit colours would be used sparingly in practice.
|
~[Red Text](c:red)
|
Red Text | The "c:" prefix denotes the text colour. |
~[Green Highlight](h:lime)
|
Green Highlight | The "h:" prefix denotes the highlight colour. |
~[Multi](c:red,h:lime)
|
Multi |
External Links
Markdown (Wikipedia)