-
Notifications
You must be signed in to change notification settings - Fork 104
Supported Markdown
The Evernote plugin supports two-way Markdown editing of notes. Two-way here means that not only can you write your notes in Markdown and have them converted to rich-text notes when saving them to Evernote, but you also can open a note and have it converted back to editable Markdown, from the rich-text version stored on Evernote.
When opening, from Sublime Text, a note stored on Evernote, two of the following can happen:
- if the note was created/last updated with the plugin then the Markdown code will be derived from an hidden element of the note and will match exactly the code you wrote to generate the note's content;
- if the note was created/last updated by another client, the Markdown will be recreated from the rich-text internal representation used by Evernote. This is not 100% accurate, as, for instance, there is no way one can infer whether an emphasized element was created using
*...*
or_..._
so one of the two is picked arbitrarily. Other ambiguities are treated similarly, by either choosing a canonical Markdown representation or by inserting raw HTML.
Basic Markdown is fully supported.
Fenced code blocks GitHub style are supported.
If a language is specified, pygments
is used to highlight the code.
GitHub checklist is supported:
- [ ] Unchecked
- [x] Checked
rendered using Evernote's built-in checkboxes.
The code [^ref]
puts a note marker in the text (rendered with a <sup>
element), [^ref]: note text
specifies the contents.
The footnotes are rendered in a <div>
element with title="footnotes"
and the footnotes
style applied to it.
Take extra care in not using prohibited elements (see here).
Evernote will complain if you use unsupported elements (such as <style>
) or unsupported attributes (such as class
or id
).
If you wish to have the code within a raw html block interpreted as Markdown, specify a markdown="1"
attribute for the outermost element:
<div markdown="1">
**Note**:
This is important!
</div>