Markdown guide
- Audrey Altman (Unlicensed)
Some of our data entry fields use Markdown for text formatting. Markdown allows you to indicate formatting with plain text, and can be converted into HTML. Programmatically, Markdown is easier to manage than HTML. For those doing data entry, Markdown is easier to read than HTML.
This page has some examples of Markdown syntax that you are likely to use in the course of data entry. For a more comprehensive list of formatting options, see Markdown Syntax Documentation.
| Formatting element | Markdown syntax | Rendered HTML |
|---|---|---|
| Link | Visit the [Digital Public Library of America](http://dpl.a). | Visit the Digital Public Library of America. |
| Italics | I *love* libraries. | I love libraries. |
| Bold | I **love** libraries. | I love libraries. |
| Numbered list | 1. Bird 2. Bat 3. Bee
Note that each item in a numbered list must appear on its own line. This: 1. Bird 2. Bat 3. Bee would not generate a properly formatted numbered list. |
|
| Paragraphs | Text is formatted as a paragraph by default. Hitting return once will not form a new paragraph, nor will it create a line break.
To form a new paragraph, hit return twice. | Text is formatted as a paragraph by default. Hitting return once will not form a new paragraph, nor will it create a line break. To form a new paragraph, hit return twice. |
| Footnote | This is a sentence.[^1] [^1]: This is a footnote. | This is a sentence.1
|