Skip to content

Latest commit

 

History

History
324 lines (228 loc) · 6.71 KB

README_zh.md

File metadata and controls

324 lines (228 loc) · 6.71 KB

Evermark

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

将 markdown 笔记同步到 Evernote 的命令行工具 🐘

English 中文

一些功能特性:

  • 支持发布 markdown 笔记到 evernote
  • 支持从 evernote 取消发布 markdown 笔记
  • 支持添加笔记本和标签
  • 支持代码高亮,表格和插入图像
  • 支持 todo-list 和 LaTeX 表达式
  • 支持流程图、序列图和甘特图

安装

npm install -g evermark

命令

初始化 Evermark 目录

初始化 Evermark 目录, 将配置信息保存到 evermark.json 文件。

evermark init <destination>
  1. 首先,按照提示选择是使用 Evernote International 还是印象笔记。
  2. 然后使用您的帐户从自动打开的页面登录,生成 developerToken 并复制它。
  3. 最后,根据提示粘贴上一步复制的 developerToken

生成 developerToken 的链接地址:

查看或修改配置

evermark config [name] [value]

添加笔记

Evermark 目录的 notes 目录下创建一个空的 markdown 笔记。

evermark new <title>

发布笔记

将 markdown 笔记发布到 Evernote 或者更新已发布的 markdown 笔记。

evermark publish <file_or_directory>

取消发布笔记

删除 markdown 笔记对应的 Evernote 笔记,markdown 笔记文件不会被删除。

evermark unpublish <file_or_directory>

查看帮助

evermark help [command]

支持的 Markdown 语法

标题

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

强调

*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~~_

上标和下标

19^th^
H~2~O

表情符

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

链接

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

引用

As Kanye West said:

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

列表

无须列表

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

有序列表

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

任务列表

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

表格

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

图片

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

行内代码

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

代码块

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

图表

Evermark 通过 mermaid 来支持流程图、序列表和甘特图。
具体语法请查看 mermaid 文档

流程图

```
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D
```

Flow Diagram

序列图

```
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!
```

Sequence Diagram

甘特图

```
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
```

Gantt Diagram

数学公式

Evermark 使用 LaTeX 语法来写数学公式。

行内公式

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}$.

Inline Math 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)
$$

Block Math Equations

原始 HTML

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

其他语法

笔记本和标签

Evermark 使用 @(Notebook)[tag1|tag2|tag3] 语法来选择笔记本并为笔记设置标签。

标题

Evermark 以 markdown 笔记内容中的第一个标题作为笔记名称。

贡献和讨论

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

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

微信赞赏 支付宝赞赏

License

MIT