什么是 MarkEditor

MarkEditor 是一款 Markdown 编辑器,自带多种写作相关的功能。无论是纯粹的 Markdown 文本写作,还是文档目录管理、博客同步写作等场景,MarkEditor 都有出色表现。

如果以前没有用过,可以先看一下 关于 MarkEditor 的相关文章

为什么用 MarkEditor 来写少数派文章

从少数派建站以来,推出过两版线上编辑器,但由于开源方案以及开发能力的限制,功能和写作体验一直是我们的弱项。这一次与 MarkEditor 开发者海波的合作,从确定方案到开发对接,仅仅三周时间就进入内部测试。基于 MarkEditor 应用本身优秀的功能,结合与少数派文章的同步、发布、审核等使用场景,我们相信会给到作者们一个全新的写作体验。

如何获取 MarkEditor

1. MarkEditor for Mac

MarkEditor 2.0 for Mac 的试用版,功能仅限于 MarkEditor 标准版的功能。包含与少数派同步的功能。试用版会有打开 Tabs 总量的限制,以及间隔一段时间的提醒。无使用时间的限制。对于签约作者,我们将会免费提供正式版 License,请关注运营公告。
下载地址:https://www.markeditor.com/

2. Markdown.app for Mac(免费)

Markdown.app 来自 MarkEditor 相同的代码,默认不提供文档列表的功能(需要 Special License 解锁),是一个纯 Markdown 编辑器。在文档列表,Markdown.app 不像 MarkEditor 使用两栏结构,而只有一栏(直接隶属当前文档所在的其他文章列表)。Markdown.app 适用于满足一层目录结构,且希望获得与 MarkEditor 同样使用体验的新用户以及轻度用户。对于老用户,更推荐使用 MarkEditor。少数派专用 Special License:

F6dg5iq/F9x41Hx+sWQmGP19EkqjF0QE0bCj5/+HcCpu8NoDBackkQe/aKLhok32TZ59Rcpm7XxFtFwobMaWrSdiBQdRugYdvZo+xglM44A=

下载地址:https://markdown.app/

3. MarkEditor 1.0 for Windows(32bit & 64bit)

「或许没有 2.0 for Mac 的存在,1.0 也会是优秀的 App 吧。」来自 MarkEditor 开发者。
1.0 for Windows 版已经接入少数派,同步体验与 2.0 for Mac 基本一致,但缺少如关键词目录、检索、排序等等 2.0 特有的功能。
下载地址:https://zrey.com/app/markeditor

如何使用 MarkEditor

本文不过多介绍如何使用 MarkEditor 的基本功能。作者们可以阅读少数派的文章介绍:https://sspai.com/search/article?q=markeditor

开发者也为软件使用做了详细的教程,只要安装好 MarkEditor,自带的示例文档就可以看到。如果不小心删除了示例文档,可以通过菜单的帮助重新阅读。

少数派用户 Token

MarkEditor 支持「云端同步」,而少数派特别版则加入了对少数派的支持。

配置的流程非常简单,作者们只要在少数派网站里,帐号设置的 Token 管理页 创建一个 Token,然后复制到 MarkEditor 菜单的「云端—少数派—配置」里即可。

同步你的少数派文章

我们强烈建议在开始配置与同步之前,(双击 alt 键)创建一个空白的工作目录且始终使用该目录与少数派进行同步,以便写作同步过程中保持少数派文档的独立,保持良好的归档习惯。

MarkEditor 菜单中,「云端—少数派」下拉框里有几个选项。

  • 同步到云端:将本地文档的改动同步到少数派
  • 同步自云端:将少数派网站的文章改动同步到本地
  • 显示同步日志:打开日志窗口,可以看到数据传输的日志,如果同步有异常,建议打开查看错误信息
  • 配置:输入 Token 的地方,如果 Token 已重置或新建了 Token,在这里重新提交
  • 重置同步:删除同步日志和已同步文件的元信息,下一次需要重新同步

工作目录与目录管理

如果你是第一次使用 MarkEditor 与少数派同步,建议认真阅读一下本章节说明。特别是少数派中有不少已经撰写数百上千篇文章的作者,如果直接同步,会在本地创建同样数量的文档,与本地已有文档混在一起将很难管理。

MarkEditor 有工作目录的概念,即用户可以通过创建和管理多个独立的文件夹,使用时通过切换以进入独立的工作空间。

首先进入菜单的「文件—工作目录管理器」(双击 alt 键),在这里创建一个目录,如命名为 SSPAI,并双击图标进入此工作目录。

这时点选菜单里的「同步自云端」,会把你在少数派写过的所有文章,以文档的形式保存到本地。在 MarkEditor 中,第一次同步的时候,是按照文章创建时间,根据 year/month/ 这样的路径进行归档的。

注意:此归档方式仅会在你的帐号进行第一次执行「同步自云端」时才会出现。

MarkEditor 是允许按照自己的归档方法对文档进行管理的,你可以直接在应用里创建目录,并对文档拖动管理。也可以通过在目录列表里点右键,选「在 Finder 中查看」直接打开 Finder 进行管理。

如果你对文档的目录结构进行过调整,并且点选「同步到云端」后,下一次同步,则会按照调整过的目录结构同步到本地。

关键词目录

“关键词目录” 本身是一个普通的文件夹,但是并不实际存储文档, 而是有一个对应的设置项,根据输入的关键词,自动匹配当前工作目录下的所有相对应的文档。

以上说明来自官方教程:https://we.markeditor.com/post/how-to-use-keyword-folder-to-filter-documents?keyword=%E5%85%B3%E9%94%AE%E8%AF%8D%E7%9B%AE%E5%BD%95#main

其实可以这样理解,关键词目录,就是创建一个目录,里面的文章是动态筛选自所有文档中有相同关键词的文档。

设置方法是在 MarkEditor 左侧目录列表空白处右键,点「新建关键词目录」,输入一个名称后确定,在目录列表会看到这个目录,然后在该目录右键,点「设置关键词目录」,输入你想要进行筛选的关键词即可。

使用关键词目录功能,可以实现多种「智能」的文档管理方式,这里仅列出通过 Meta 元信息进行设置的两种方案。

方案一:通过文章状态管理

从少数派同步回来的文章都会带 Meta 信息(下面会详细讲),附带该文章的标题、标签、题图、发布状态等。我们可以这么设置关键词目录,使得所有同步回来的文档,按照文章状态进行归类。

关键词目录名称 关键词
已发布 status: public
被推荐到首页 status: sspai
审核状态 auditing_status
草稿 status: draft

设置完成后,目录列表是这样的:

方案二:通过文章标签管理

同样的逻辑,通过文章中 Meta 信息里的 tags,也可以这么设置:

关键词目录名称 关键词
iOS #iOS#
iPhone #iPhone#
评测 #评测#
资讯 #资讯#
教程 #教程#
学习管理 #学习管理#

设置完成后,目录列表是这样的:

总之,关键词目录的设置方式不会限制于少数派的文章状态或标签分类,作者们可以按照自己的方式来做文档管理。

新建文档

新建文档很简单,只要在想要的目录里,在文档列表栏点 + 即可新建一个文档。新建时可以为文档命名。文档的名称对于少数派是没有任何影响的,只是方便本地管理。

另外对于在 MarkEditor 对接少数派同步时,新建文档需要注意以下几点。

1. Meta 信息

以上截图应该看到过,同步自云端的每个文档都会带一段信息,如:

---
title: NFC 标签联系人写入教程:Tagstand Writer
status: sspai
date: 2013-08-07 10:58:47
to: sspai
auditing_status: pass
comment: yes
toc: no
tags: #Android#, #教程#, #技巧#, #应用#
id: 23783
cover: https://cdn.sspai.com/attachment/origin/44/08/05/50844.jpg
url: https://sspai.com/post/47278
---

这就是 Meta 信息,里面的 title、status、date、to 这些都是声明这个文档在少数派上的状态和信息。

所以在新建一篇文章时,我们可以修改这些声明的值,在同步到云端时,「告诉」服务器这篇文章你需要做怎样的操作或设置。

以下是每一项声明的内容描述:

声明 内容描述 可否主动声明
title 文章标题
status 文章状态(draft 草稿;deleted 已删除;public 发布;sspai 推荐到首页)
date 文章发布时间
to 是否提交审核,如果是签约作者提交文章,请将 status 声明为 draft 并在此项写 sspai
auditing_status 审核状态(pending 待审核;pass 已审核;rejected 已拒绝)
comment 是否打开评论(yes or no)
toc 是否打开目录(yes or no)
tags 文章标签,使用 # 包裹并以 , 分隔
id 少数派上的文章 id
url 少数派上的 url 地址
cover 题图,可以通过图片管理器插入或直接拖动插入

在「可否主动声明」一列的项目,如果标注「是」,则可以在新建文档时填写;如果标注「否」,则说明是从少数派同步到本地时附带的信息,即使在本地修改了,也无法同步到少数派。

特别注意
  • id:不要自行填写或修改 id,以免同步时发生错误。
  • date:写入此字段会更改文档的创建时间。从云端同步到本地的话会附带此字段,但这时修改 date 并不会同步到云端。云端的创建时间还是以实际创建文档的时间为准。如果处于本地文档管理的需要,可以创建或修改 date 声明,当前日期的创建快捷键是 Shift+Command+D。
  • status:创建文章时如果没有声明,同步后默认是 public 状态。
  • to:如果此声明填了 sspai,无论 status 填什么状态,文章都会以 draft 的状态提交审核。

我们新建一篇要发布到少数派的文章,至少要写一条声明:

---
title: 文章标题
---

该篇文档在同步之后,会直接发布到少数派个人帐户下。而在下一次「同步自云端」时,MarkEditor 会检测与线上的数据有无改动,并且为 Meta 信息加上线上发布的 id 与 status。

2. Markdown 格式

MarkEditor 使用纯 Markdown 语言撰写文档,同步后在少数派会以对应 html 内容呈现。基本上只要是 Markdown 支持的语法,在少数派页面上都可以完美展示。

关于一些 Markdown 语法规则的问题,请看 MarkEditor 官方的说明:https://we.markeditor.com/category/Markdown#main

3. 插图与图片标题

在 MarkEditor 中插入图片很简单,可以直接把图片拖动到编辑器的光标处即可。在正常的编辑模式下,如果是插入题图,图片呈现为路径的格式,如 cover: ./_image/2018-07-12/Screen Shot 2018-09-25 at 11.47.21.jpg;如果是在正文区域插入题图,则会直接显示图片。

与少数派的正文图片附件规则一致,我们只允许同步 2.5MB 以下的图片。如果图片超过 2MB,MarkEditor 会先对图片进行缩放处理,最大宽度为 2560px;如果缩放之后仍然超过 2.5MB,则以最大宽度 1280 进行缩放。

另外需要注意的是,由于少数派采用了七牛 CDN,如果内容有图片,在同步完成之前,不要访问线上的地址,否则可能造成一段时间图片的 404。

图片标题 在 MarkEditor 中插入图片之后,如果要写图片标题,在接下来的一行写标题即可,写完后空一行再继续写正文。

发布后效果

4. 应用卡片和解链接

MarkEditor 针对少数派应用卡片和解链接的输入和解析做了支持。格式为:

[app]应用名称[/app]
[link]url[link]

注意,应用名称必须匹配应用库里的应用名,否则无法解析。

由于应用库本身规则的限制,即如果一个应用没有在线上编辑器提交的话,是无法在 MarkEditor 上解析成应用卡片的,所以如果要输入一个应用卡片,在同步后发现没有显示,可以先打开线上的编辑器:https://sspai.com/write,提交一下应用的地址,在应用库创建对应的项目,然后就可以正常显示了。

代码示例:

[app]Qq[/app]
[app]美图秀秀[/app]
[app]Maipo - 极致微博体验[/app]
[link]https://www.jianshu.com/p/abaff828100d[/link]
[link]https://sspai.com/post/47220[/link]

文章页解析后显示:


5. 视频

直接插入使用 iframe 标签的 html 代码到文本中即可。如:

<iframe allowfullscreen="" frameborder="0" src="https://v.qq.com/iframe/player.html?vid=c0502pizvfb&amp;tiny=0&amp;auto=0" width="100%"></iframe>

6. 提交审核与文章更新

对于日常需要撰写文章并将文章提交到后台的签约作者,使用 MarkEditor 提交即可。但应注意:

  • 在 MarkEditor 创建文档,Meta 信息中应注意包含 to: sspai 声明,只要有 to 声明,无论 status 填什么,都会以 draft 的状态,在同步时进入审核流程
  • 在进入审核流程后,该文章可以在本地修改,但是无法同步,错误提示信息会在同步日志中显示,这一点和在少数派线上编辑器的操作权限是一致的
  • 当文章通过审核,并且发布到首页后,和少数派签约文章的逻辑#292525一样,文章也是无法再同步更新的

预览

除了同步到少数派后直接在线上文章页预览外,MarkEditor 也支持在浏览器中预览。

我们将会推出带少数派文章页样式的预览页。但其实在 MarkEditor 中,自定义样式和预览页模板也是可折腾的一个功能,具体请看:
https://we.markeditor.com/search?s=%E9%A2%84%E8%A7%88

使用反馈

可以在 slack 群组的 #feedback 中提交。

THREE MORE TIPS

一键同步 本文使用 MarkEditor 创建并撰写。在写作时,按快捷键 Ctrl+~,MarkEditor 会立刻开始同步。一个错字,直接在 MarkEditor 修改,一秒钟更新到线上。这种步枪换电磁轨炮的感觉,有待大家来体验。

Ctrl+~

快捷自动补全 如果经常写「严肃」文章,对于专有名词的拼写一定不能错。自动补全一定能用得上。在偏好设置里的「写作」里,填入一些快捷自动补全的规则,然后打开菜单「写作—启用快捷自动补全」。

填入快捷自动补全的规则

写作时输入两个部分匹配的英文字母,会弹出选框供选择相关补全

文档引用自动补全 这是一个类似于 wiki 引用内部链接的功能。开启方式是打开菜单「写作—启用文档引用自动补全」。如果文章库有很多文章,在写作时想要引用其中一篇,只需要先填入[](),然后在中括号内填写需要引用的文章标题,会弹框匹配相关的文章,选择回车就可以生成这样的链接:

[客户端内链测试页面列表](https://sspai.com/post/44508?path=%2F2018%2F05%2F44508.md)

在撰写系列文章相互引用时会很方便


最后祝大家写作愉快,谢谢!