Markdown Guide

Markdown Information

Markdown, created by John Gruber of Daring Fireball, is the technology we chose to use to allow rich text within Day One journal entries. Markdown allows italic and bold, along with several other simple formatting options that can be written using plain text and display properly in Read views. Markdown syntax is available in Day One and is toggled On by default.

Day One takes a similar approach to Markdown as GitHub. See GitHub Flavored Markdown.

The best way to see how Markdown formatting works in Day One is to refer to these sample entries:

Day One Markdown Sample Entry (Click to open in the Day One App, Mac or iOS)

Day One Markdown Sample (.text file)
Day One Markdown Sample (.text file with blockquote explanations)

Day One Markdown Syntax

Basics

*italic* or _italic_  /  **bold** or __bold__

italic or italic / bold or bold

An inline link: [example](http://dayoneapp.com/markdown).

An inline link: example.

An id link [example][id].
  [id]: http://dayoneapp.com/markdown

An id link example.

An auto-linked URL: http://dayoneapp.com/markdown

Headers

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

HEADER 1

Header 2

Header 3

Header 4

Header 5
Header 6

Lists

1. Numbered 
2. List

1. Numbered
2. List

- Bulleted
- List

- Bulleted
- List

Images

![alt text](http://bit.ly/do-image)

Alt Text

Blockquotes

> Angle brackets are used for blockquotes.

Angle brackets are used for blockquotes.

Tables

One | Two | Three
--- | --- | ---
Blue | White | Gray
Green | Yellow | Red
OneTwoThree
Blue White Gray
Green Yellow Red

Note that because the first line of journal entries has special properties associated with Day One’s auto-bolding feature, tables must start on the second or subsequent line of a journal entry.

Horizontal Rules

Three or more dashes or asterisks --- ***

Code & Preformatted Text

<code> spans are delimited by backticks. You can include literal backticks like `this`.

[TAB]Preformatted text block using a tab.

Preformatted text block using a tab.

Markdown Footnotes

This is how to use footnotes [^1] with Markdown in Day One. 
[^1]: Supported in both iOS and Mac Apps. 

This is how to use footnotes 1 with Markdown in Day One. (see footnote at the bottom of this page)

Citations

To make citations, use <cite> at the beginning of the citation and </cite> at the end of the citation.

Day One Markdown Stylesheet and Examples

We’re looking into possible ways to allow users to create and customize the CSS / Style that’s used to render the Read views and export formats. For now you can preview the CSS that’s in use in the current apps.

https://github.com/bloom/DOMarkdown

Useful Markdown Articles:


  1. Supported in both iOS and Mac Apps. 
Was this article helpful?
8 out of 9 found this helpful

Comments

Please sign in to leave a comment.

Have more questions? Submit a request