markdown-Marxico

发表于 | 分类于
字数统计 753 | 阅读时长 4
markdown常用语法 6.25

Welcome to Marxico

@(Sample notebook)[Marxico|Manual|Markdown]

Marxico is a delicate Markdown editor for Evernote. With reliable storage and sync powered by Evernote, Marxico offers greate writing experience.

  • Versatile - supporting code highlight, LaTeX & flow charts, inserting images & attachments by all means.
  • Exquisite - neat but powerful editor, featuring offline docs, live preview, and offering the desktop client and offline Chrome App.
  • Sophisticated - deeply integrated with Evernote, supporting notebook & tags, two-way bind editing.

[TOC]

Introducing Markdown

Markdown is a plain text formatting syntax designed to be converted to HTML. Markdown is popularly used as format for readme files, … or in text editors for the quick creation of rich text documents. - Wikipedia

As showed in this manual, it uses hash(#) to identify headings, emphasizes some text to be bold or italic. You can insert a link , or a footnote[^demo]. Serveral advanced syntax are listed below, please press Ctrl + / to view Markdown cheatsheet.

Code block

1
2
3
4
5
6
7
8
9
10
@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
class SomeClass:
    pass
>>> message = '''interpreter
... prompt'''

LaTeX expression

$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

Table

Item Value Qty
Computer 1600 USD 5
Phone 12 USD 12
Pipe 1 USD 234

Diagrams

Flow charts

1
2
3
4
5
6
7
8
st=>start: Start
e=>end
op=>operation: My Operation
cond=>condition: Yes or No?

st->op->cond
cond(yes)->e
cond(no)->op

Sequence diagrams

1
2
3
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

Note: You can find more information:

  • about Sequence diagrams syntax here,
  • about Flow charts syntax here.

Checkbox

You can use - [ ] and - [x] to create checkboxes, for example:

  • Item1
  • Item2
  • Item3

Note: Currently it is only partially supported. You can’t toggle checkboxes in Evernote. You can only modify the Markdown in Marxico to do that. Next version will fix this.

Dancing with Evernote

Notebook & Tags

Marxico add @(Notebook)[tag1|tag2|tag3] syntax to select notebook and set tags for the note. After typing @(, the notebook list would appear, please select one from it.

Title

Marxico would adopt the first heading encountered as the note title. For example, in this manual the first line Welcome to Marxico is the title.

Quick Editing

Note saved by Marxico in Evernote would have a red ribbon button on the top-right corner. Click it and it would bring you back to Marxico to edit the note.

Note: Currently Marxico is unable to detect and merge any modifications in Evernote by user. Please go back to Marxico to edit.

Data Synchronization

While saving rich HTML content in Evernote, Marxico puts the Markdown text in a hidden area of the note, which makes it possible to get the original text in Marxico and edit it again. This is a really brilliant design because:

  • it is beyond just one-way exporting HTML which other services do;
  • and it avoids privacy and security problems caused by storing content in a intermediate server.

Privacy Statement: All of your notes data are saved in Evernote. Marxico doesn’t save any of them.

Offline Storage

Marxico stores your unsynchronized content locally in browser storage, so no worries about network and broswer crash. It also keeps the recent file list you’ve edited in Document Management(Ctrl + O).

Note: Although browser storage is reliable in the most time, Evernote is born to do that. So please sync the document regularly while writing.

Shortcuts

Help Ctrl + /
Sync Doc Ctrl + S
Create Doc Ctrl + Alt + N
Maximize Editor Ctrl + Enter
Preview Doc Ctrl + Alt + Enter
Doc Management Ctrl + O
Menu Ctrl + M

Bold Ctrl + B
Insert Image Ctrl + G
Insert Link Ctrl + L
Convert Heading Ctrl + H

About Pro

Marixo offers a free trial of 10 days. After that, you need to purchase the Pro service. Otherwise, you would not be able to sync new notes. Previous notes can be edited and synced all the time.

Credits

Marxico was first built upon Dillinger, and the newest version is almost based on the awesome StackEdit. Acknowledgments to them and other incredible open source projects!

Feedback & Bug Report

Thank you for reading this manual. Now please press Ctrl + M and click Link with Evernote. Enjoy your Marxico journey!

[^demo]: This is a demo footnote. Read the MultiMarkdown Syntax Guide to learn more. Note that Evernote disables ID attributes in its notes , so footnote and TOC are not actually working.

0%