Markdown

From ContactsLaw Documentation
Revision as of 09:37, 18 July 2023 by Bradley Smith (talk | contribs)

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
  1. Ordered List
List items are automatically numbered, so you need only place a '1' beside each.
- Unordered List
  • 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:

  • TBA

External Links

Markdown (Wikipedia)