Home

Awesome

Evermark

NPM version Build Status Windows Build Status Coverage Status Dependency Status Dependency Status

A command line tool for syncing markdown notes to Evernote :elephant:

English 中文

Some features:


Install

npm install -g evermark

Commands

Initialize Evermark Folder

Initialize Evermark folder, save settings to file evermark.json

evermark init <destination>
  1. First, follow the prompt to select whether you are using Evernote International or 印象笔记.
  2. Then login with your account from automatically opened page to generate developerToken and copy it.
  3. Finally, according to the prompt paste the copied developerToken.

The urls to generate developerToken:

View or Modify the Configuration

evermark config [name] [value]

Add Note

Create a empty markdown note in the notes directory of the Evermark folder.

evermark new <title>

Publish Notes

Publish markdown notes to Evernote or update the published notes.

evermark publish <file_or_directory>

Unpublish Notes

Delete the Evernote note which corresponding the markdown note, but the markdown note file will not be deleted.

evermark unpublish <file_or_directory>

View Help

evermark help [command]

The Supported Markdown Syntax

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

Emphasis

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

~~This text will be crossed~~

_You **can** combine ~~them~~_

Sups & Subs

19^th^
H~2~O

Emoji

:smile: :heart: :sunny: :watermelon: :cn:

Links

http://github.com - automatic!
[GitHub](http://github.com)

Blockquotes

As Kanye West said:

> We're living the future so
> the present is our past.

Lists

Unordered

- Item 1
- Item 2
  - Item 2a
  - Item 2b

Ordered

1. Item 1
1. Item 2
1. Item 3
   - Item 3a
   - Item 3b

Task Lists

- [x] Write blog post with :heart:
- [x] Create sample **gist**
- [ ] Take screenshots for blog post

Tables

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

Images

![Image of Test](img/test.png "Image of Test")
![GitHub Logo](https://assets-cdn.github.com/images/modules/logos_page/Octocat.png "GitHub Logo")

Inline Code

This is an inline code: `var example = true`

Block Code

```js
console.log('Hello world!')
```

Diagrams

Evermark supports flow charts, sequence diagrams and gant diagrams by using mermaid.<br> Please see the mermaid docs for more details.

Flow Diagrams

```
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D
```
<img src="media/flow-diagram.png" alt="Flow Diagram" width="414">

Sequence Diagrams

```
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts<br/>prevail...
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```
<img src="media/sequence-diagram.png" alt="Sequence Diagram" width="421">

Gantt Diagrams

```
gantt
    title A Gantt Diagram

    section Section
    A task           :a1, 2014-01-01, 30d
    Another task     :after a1  , 20d

    section Another
    Task in sec      :2014-01-12, 12d
    anther task      : 24d
```
<img src="media/gantt-diagram.png" alt="Gantt Diagram" width="555">

Math Equations

Evermark supports LaTeX expression for math.

Inline Equations

When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are
$x = {-b \pm \sqrt {b^2-4ac} \over 2a}$.
<img src="media/inline-math-equations.png" alt="Inline Math Equations" width="659">

Block Equations

$$
\displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }
$$

$$
\displaystyle \left( \sum_{k=1}^n a_k b_k \right)^2 \leq
\left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
$$
<img src="media/block-math-equations.png" alt="Block Math Equations" width="270">

Raw HTML

<div style="color: red;">This is a <strong>html</strong> code.</div>

Other Syntax

Notebooks & Tags

Evermark add @(Notebook)[tag1|tag2|tag3] syntax to select notebook and set tags for the note.

Title

Evermark would use the first heading encountered as the note title.

贡献和讨论

欢迎提交 issue 来优化完善这个项目。

如果此项目对您有很大的帮助, 请酌情考虑打赏作者。

<table> <tr style="border:0"> <td style="border:0"><img src="media/wechat.jpg" alt="微信赞赏" width="200"></td> <td style="border:0"><img src="media/alipay.jpg" alt="支付宝赞赏" width="200"></td> </tr> </table>

License

MIT