Content formatting guide

Contents

This guide applies to these Markdown enabled fields:

  • identification.title
  • identification.abstract
  • identification.purpose
  • identification.lineage.statement

Italics

Some *italic* text.

Some italic text.

Bold

Some **bold** text.

Some bold text.

Strikethrough

Some ~~strikethrough~~ text.

Some strikethrough text.

Inline code

Some `code` in text.

Some code in text.

Email addresses

Do not include email addresses in item titles.
Inline email address will be automatically converted to links. 
connie.watson@example.com
[Contact Us](mailto:hello@example.com)

connie.watson@example.com

Contact Us

Horizontal Rule

Do not use horizontal rules in item titles. 
...
---
...

...

...

Unordered list

Do not use lists in item titles. 
...
* list item 1
* list item 2
  * list item 2.1
* list item 3
...

...

  • an item
  • another item
    • a sub-item
  • another item

...

Ordered list

Do not use lists in item titles. 
...
1. first item
2. second item
    1. second item sub-item
3. third item
...

...

  1. first item
  2. second item
    1. second item sub-item
  3. third item

...

Blockquote

Do not use blockquotes in item titles. 
...
> Some text in a blockquote ...
>
> ... over multiple lines.
...

...

Some text in a blockquote ...

... over multiple lines.

...

Code block

Do not use code blocks in item titles.
Code blocks do not support syntax highlighting. 
...
```
Some text in a code block.
```
...

...

Some text in a code block.

...

Admonition (Note)

Do not use notes in item titles. 
...
> [!NOTE]
> Some text shown as a note.
...
> [!note] Custom note
> A note, with custom title (and lower-case trigger).
...

...

Note

Some text shown as a note.

...

Custom note

A note, with custom title (and lower-case trigger).

...

Admonition (Tip)

Do not use tips in item titles. 
...
> [!TIP]
> Some text shown as a tip.
...
> [!tip] Custom tip
> A tip, with custom title (and lower-case trigger).
...

...

Tip

Some text shown as a tip.

...

Custom tip

A tip, with custom title (and lower-case trigger).

...

Admonition (Important)

Do not use importants in item titles. 
...
> [!IMPORTANT]
> Some text shown as a important.
...
> [!important] Custom important
> A important, with custom title (and lower-case trigger).
...

...

Important

Some text shown as a important.

...

Custom important

A important, with custom title (and lower-case trigger).

...

Admonition (Warning)

Do not use warnings in item titles. 
...
> [!WARNING]
> Some text shown as a warning.
...
> [!warning] Custom warning
> A warning, with custom title (and lower-case trigger).
...

...

Warning

Some text shown as a warning.

...

Custom warning

A warning, with custom title (and lower-case trigger).

...

Admonition (Caution)

Do not use cautions in item titles. 
...
> [!CAUTION]
> Some text shown as a caution.
...
> [!caution] Custom caution
> A caution, with custom title (and lower-case trigger).
...

...

Caution

Some text shown as a caution.

...

Custom caution

A caution, with custom title (and lower-case trigger).

...

Headings

Do not use headings in item titles. 
# Heading 1
...
## Heading 2
...
### Heading 3
...
#### Heading 4
...
##### Heading 5
...
###### Heading 6
...

Heading 1

...

Heading 2

...

Heading 3

...

Heading 4

...

Heading 5

...

Heading 6

Tables

Do not use tables in item titles.
Table rows do not need padding to align them, as shown in this example. 
...
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
| Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 |
...

...

Header 1 Header 2 Header 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 Row 2 Col 2 Row 2 Col 3
Row 3 Col 1 Row 3 Col 2 Row 3 Col 3

...

Images

Do not use images in item titles. 
...
```
![Trees & snow](https://images.unsplash.com/photo-149...)
```
...

...

...