潘大志的博客

欢迎来到 MarkEditor

2024-06-09T02:46:04Z

好的写作体验，是 MarkEditor 的基础。
但本质而言，MarkEditor 是一个效率工具，它的重点在于如何节省使用者的时间。

MarkEditor 管理的是文件

MarkEditor 支持多个 Tab，每个 Tab 对应一个 工作目录，每个工作目录，相当于一个工作场景。

MarkEditor 管理的是操作系统内原生的文件夹、文档文件，不会有额外的数据库创建。因此，MarkEditor 中的数据，对使用者而言，是非常容易控制的。
并且，这也为数据同步提供了更大的便捷，比如 MarkEditor 打开的一个工作目录(文件夹)，直接位于 Dropbox 或者 iCloud Drive 上的时候，那这个文件夹就自动实现云端的同步了。

第一次使用 MarkEditor 的建议

管理、添加工作目录 (快捷键为两次连按Alt键)
如果当前工作目录是自动创建的，里面的内容可以自行删除
配置当前工作目录(左下角按钮)
选择一个自己喜欢的主题；也可以多次随机生成，直到碰到自己喜欢的
开始尝试写作，比如 Markdown 的基本语法、MarkEditor 中插入图片的操作、导出为各种格式 .etc

简单地插入图片

在 MarkEditor 中插入图片，非常方便。
可以将图片直接拖入到编辑区域，也可以复制图片之后直接粘贴，MarkEditor 都会自动将图片存储到文档对应的图片文件夹内，当然，也可以按照使用者的偏好设置，决定编辑区域内的图片是直接显示、还是以 Markdown 语法的形式显示。
除此之外， MarkEditor 也提供了一个图片管理器，对文章中有较多插图的场景，提供更好、更高效的体验。

恰好的写作体验与多彩的样式

MarkEditor 尽可能使用色彩区分文本，来体现文本在Markdown的世界中最终应该是什么模样。
除此之外，还有Focus模式，凸现当前段落文本；以及夜间主题，在夜深时分，降低过亮的光线对眼睛的伤害。

MarkEditor 的视觉主题，提供了 300 多项的自定义项，基本上视觉可见的像素，都可以定制。
但也不需要这么麻烦，你可以使用随机模式的主题，多试几次，应该会遇到自己欢喜的色系。如果有进一步的想法，还可以在此基础上自定义。

导出微信公众号以及更多的可能

MarkEditor 能将单篇文章导出为 PDF、HTML、图片等格式，还有 MarkEditor URL，可以一键获得可公开访问的网页。
MarkEditor 中也可以直接导出为 微信公众号 的格式，默认内置了三种样式风格、两种样式生成器，还可以自己定义 CSS 样式。专注于内容的书写，享受写作本身的乐趣，而无需拘泥于麻烦的格式。

除此之外，MarkEditor 还能将整个工作目录内的文档，导出为一个 PDF 文档的合集、Wiki 的完整站点。
甚至于可以直接将排版好的文本内容，群发到自己的 邮件列表 中的读者们，仅仅是一个点击的操作而已。

其它资源

社区于在线帮助: https://we.markeditor.com/
微信公众号: 直接搜索 markeditor
邮件列表: 需发送邮件(任意内容)到 me@qifa.app 进行订阅

我们会在以上渠道中推送 MarkEditor 的使用技巧、设计想法、新的特性、以及一些工作流优化的案例，微信公众号相对实时性比较高，而邮件列表则有更好的阅读体验。

Enjoy!

File Template

2024-06-09T02:46:04Z

如何设定？

在文件管理器的左下角，打开当前工作目录的配置界面，在 template for new document 中输入内容即可。
之后，当前工作目录下新建的文件，默认都将以这个文件模板作为初始内容。

特殊变量

$name$ 可以获得当前新建文件的文件名（不包括后缀）。
$name_without_number$ 跟 $name$ 相似, 但是会过滤掉空格之前的数字、日期的内容。
$date<format>$ 可以获得当前的日期，并将之格式化。

比如下面的例子：

---
date: $date%Y-%m-%d %H:%M$
title: $name$
---

TimeFormat (附)

%a 本地的星期缩写
%A 本地的星期全称
%b 本地的月份缩写
%B 本地的月份全称
%c 本地的合适的日期和时间表示形式
%d 月份中的第几天，类型为decimal number（10进制数字），范围[01,31]
%f 微秒，类型为decimal number，范围[0,999999]，Python 2.6新增
%H 小时（24进制），类型为decimal number，范围[00,23]
%I 小时（12进制），类型为decimal number，范围[01,12]
%j 一年中的第几天，类型为decimal number，范围[001,366]
%m 月份，类型为decimal number，范围[01,12]
%M 分钟，类型为decimal number，范围[00,59]
%p 本地的上午或下午的表示（AM或PM），只当设置为%I（12进制）时才有效
%S 秒钟，类型为decimal number，范围[00,61]（60和61是为了处理闰秒）
%U 一年中的第几周（以星期日为一周的开始），类型为decimal number，范围[00,53]
%w 星期，类型为decimal number，范围[0,6]，0为星期日
%W 一年中的第几周（以星期一为一周的开始），类型为decimal number，范围[00,53]
%x 本地的合适的日期表示形式
%X 本地的合适的时间表示形式
%y 去掉世纪的年份数，类型为decimal number，范围[00,99]
%Y 带有世纪的年份数，类型为decimal number
%Z 时区名字（不存在时区时为空）
%% 代表转义的"%"字符

Markdown Template

2024-06-09T02:46:04Z

如何设定？

在文件管理器的左下角，打开当前工作目录的配置界面，选择 Markdown Template 即可设置。

Markdown HTML模板

Markdown 的 HTML 模板控制的是 Markdown 解析为 HTML 过程，在设置中有相应配置；除此之外，每个目录(文件夹)对应的配置内也有 Markdown HTML模板的设置，仅对当前目录内的文件生效，并且优先级高于全局的配置。

模板中需要指定{{ content }}这个变量，这是Markdown转义过来原始的HTML内容，另外{{ title }}一般放在<head><title>上，{{ css }}这个变量对应的是一个CSS样式文件，它是由当前界面风格自动生成的，你也可以用自己的样式文件替代。

<--header_scripts--> 最终会被替换为流程图支持的js文件， 则是对应数学公式支持的js文件， 表示对应 mermaid 流程图的脚本。如非自行替换，一般建议保留。

默认的 Markdown 渲染模板 (附)

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <meta name="renderer" content="webkit">
    <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" name="viewport"/>
    <meta content="yes" name="apple-mobile-web-app-capable"/>
    <meta content="black" name="apple-mobile-web-app-status-bar-style"/>
    <meta content="telephone=no" name="format-detection"/>
    <meta name="renderer" content="webkit"/>
    <title>{{ title }}</title>
    <link rel="stylesheet" href="{{ css }}">
    <!--header_scripts-->
</head>
<body>
    <div class="post">
        <div class="post_body">
            {% if for_page and meta_title and filename !='cover'%}
                <div class=title_container>
                    <h1> {{ meta_title}} </h1>
                    {% if meta_subtitle %}
                        <h2> {{meta_subtitle}} </h2>
                    {% endif%}
                </div>
            {% endif %}
            {{ content }}
        </div>
    </div>
    <!--mathjax-->
    <!--mermaid-->
</body>
</html>

Interface Theme

2024-06-09T02:46:04Z

如何应用自定义的界面主题？

1, 在界面右上角的 主题按钮 中选择 打开主题目录。
2, 把自定义主题的 csv 文件放入新打开的目录中。
3, 再点击 主题按钮 选择新载入的主题，即可。

如果创建一个主题文件？

MarkEditor 的主题自定义项超过 300 项，本身是一个 csv 格式的文件。

一般创建主题文件有两种方式：
1，修改已有的主题文件，但注意要同时修改第一行的 key 值。
2，点击 主题按钮 上的 简单智能定制，尝试随机样式之后，并最终选择 保存为 .csv 也能获得一个 csv 格式的文件。

如何微调、修改主题？

可以使用 Numbers 之类的 App 直接打开主题的 csv 文件进行编辑，主题文档内一般都会自带标注说明当前行的定义值有什么作用。
修改之后，重新保存为 csv 格式的文件，当然前提是保存在主题目录内。
之后，再点击 主题按钮 重新选择对应的主题，MarkEditor 的界面就会重新载入当前主题的自定义。

File List

2024-06-09T02:46:04Z

文件管理器基本布局

默认的文件管理器包括两个部分组成: 目录列表 + 文档列表，在 视图 窗口中，可以选择两个部分具体显示哪个。
如果只有一个 目录列表，则会变成比较经典的树状文件管理器；如果只留 文档列表，则文件管理器仅保留一栏文档列表的模式。

自定义文档列表的摘要行数

默认情况下，文档列表中文章会选取正文的内容，呈现前 3 行作为当前文档的摘要。
你可以在 文件管理器 的左下角，对当前 工作目录 进行设置，将 摘要行数 选择为自己需要的数量。其中，0 是一个特殊值，表示不呈现摘要。

自定义文档列表摘要的内容

文档摘要由三个组成部分，为图标、标题、摘要内容。
在帮助文档的 Markdown -> Meta 支持 中我们描述过在 Markdown 中如何添加额外的属性。文档摘要的三个组成部分，也分别对应了特别的 Meta 的 key，分别为 icon、title、summary。
示例如下:

---
icon:  👿
title:  摘要的标题
summary:  这是摘要的内容说明。
---

Tip: 我们会建议如果自定义文档的 icon，使用 emoji 表情 (快速插入的快捷键为 Ctrl+Command+空格键)，在一些特别的笔记方法、场合中，这样的图标自定义会很有帮助。

自定义目录(文件夹)列表中的图标

如果文件夹内有 icon.png 这个图片文件，则它在显示的时候，图标就是这张图片。

PDF EBook

2024-06-09T02:46:04Z

电子书页面微调

在 PDF 电子书导出的时候，有一个设置项为 PDF 页面 CSS，可以设定额外的 CSS 规则，影响单页面的样式。
比如下面的 CSS，将影响到页面内的 H1、H2、H3 对应的标题字体色、页面二级标题的字体色、页面标题的底部分割线条样式。

h1,h2,h3{color:#111 !important} 
.title_container h2{color:#999 !important}
.title_container {border-bottom: 3px double #eeeeee  !important;}

电子书的封面

一、使用图片作为封面

如果目录内有 cover.png 或 cover.jpg, 并且导出电子书的时候，没有勾选 自动封面，那么对应的图片就会成为电子书的封面，这个封面图片建议按照 A4 的尺寸设计。

二、使用 cover.md

在所导出的根目录内如果有 cover.md, 则会使用其作为电子书的封面。下面是一个示例，其实质是一个 HTML 的代码片段(Markdown 内可直接写 HTML):

<div style="height:29cm" >
<div style="text-align:center; color:#333; padding-top:9.5cm;font-size:3.5em;line-height:0.8" >
电子书的标题
<div style="font-size:16px;margin-top:50px;line-height:1.2;color:#555;">电子书的二级标题</div>
</div>
</div>

三、使用自动封面

如果没有 cover.md 对应，且在导出电子书的时候勾选了 自动封面，则 MarkEditor 会根据指定的电子书标题、二级标题，自动生成一个 cover.md，但其字体、字体颜色会根据当前的主题，自动匹配。

电子书目录索引

默认情况下，电子书的目录索引的样式，会根据当前 App 的主题而自适应。你也可以自行进行定义:

Shift+Command+C 打开数据目录，创建一个子目录 pdf_book, 并在里面创建一个 html 文件，文件名为 toc.html
复制、粘贴 MarkEditor 默认的源码
进行修改

一般有以下方面可以修改，除此之外，不建议再另行修改源码:
1，<div class="index_title"> INDEX </div> 可以改成比如 <div class="index_title"> 目录 </div>
2，删除 {{ auto_css_content }} 并添加自己的 css 样式，常用的几个定义内容如下:

body {background: 整体背景色;}
.index_title {color:INDEX标题的颜色}
a {color: 索引链接的颜色}
li li a { color: 二级以上索引链接的颜色}
li a {border-bottom-color:  连接线颜色}

默认模板源码:

<!DOCTYPE html>
<html>
<head>
    <title> PDF BOOK TOC </title>
    <meta charset="UTF-8"/>
    <meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
    <style type="text/css">
        body{
            font-size: 13px;
        }
        ul{
            list-style: none;
        }
        li{
            margin: 10px 0;
        }
        a{
            text-decoration: none;
            page-break-inside: avoid;
        }
        li a{
            position: relative;
            display: block;
            padding: 4px 0 12px 0;
            border-bottom-width: 1px;
            border-bottom-style: solid;
        }
        li li a{
            padding: 1px 0 8px 0;
            font-size: 12px;
        }
        li li a .page_num{
            top: 1px;
        }
        li a .title{
            padding-left: 5px;
        }
        li a .page_num{
            padding-left: 10px;
            position: absolute;
            right: 8px;
            top: 6px;
        }
        li ul{
            padding-left: 20px;
            margin-bottom: 20px;
        }
        .index_title{
            font-size: 2em;
            text-align: center;
            margin-bottom: 1em;
        }
        .toc{
            padding-left: 0;
        }
    </style>
    {{ auto_css_content }}
</head>
<body>
    <div class="index_title"> INDEX </div>
    <ul class="toc">
        {% if root_doc.content %}
        <li>
            <a href="{{root_doc.pdf_page_link}}">
                <span class="title">{{root_doc.title}}</span>
                <span class="page_num">1</span>
            </a>
        </li>
        {% endif %}
        {% for doc in docs %}
            {% set loop1 = loop %}
            <li>
                <a href="{{doc.pdf_page_link}}">
                    <span class="title">{{doc.title}}</span>
                    <span class="page_num">{{doc.pdf_page}}</span>
                </a>
                {% if doc.children %}
                    <ul>
                    {% for sub_doc in doc.children %}
                         <li>
                             <a href="{{sub_doc.pdf_page_link}}">
                                <span class="title">{{sub_doc.title}}</span>
                                <span class="page_num">{{sub_doc.pdf_page}}</span>
                            </a>
                          </li>
                    {% endfor %}
                    </ul>
                {% endif %}
            </li>
        {% endfor %}
    </ul>
</body>
</html>

Bitcron

2024-06-09T02:46:04Z

Bitcron 的同步如何设置？

Site Token

Site Node

类似 us.bitcron.com，是指自己网站所在的某个（服务器）节点。可以不输入，会自动匹配到网站的主节点。

Domain

自己网站可访问的域名。

注意事项

不要暴露自己的 Site Token，如果感觉自己的 Site Token 已经暴露了，请登录 Bitcron 进行 Token 的重置。
如果 Bitcron 上的网站本身已经绑定了 Dropbox，则不需要再通过 MarkEditor 来同步了，只需要将对应的网站目录在 MarkEditor 中打开即可，数据会借助 Dropbox 自动同步到 Bitcron 上。

FAQ

2024-06-09T02:46:04Z

MarkEditor 可以使用 Dropbox 同步吗？

ME 的云同步特指接入第三方(一般是商业)云，软件本身没有账户体系，也不具备直接同步的功能。
但是得益于 ME 的管理对象是文件夹、文档，所以，你可以使用 ME 打开已位于云端(比如 Dropbox)上的文件夹，这样其实就自动获得了云同步的功能。

可以同时在一个工作目录内配置多个云端同步吗？

可以。
不论是 Bitcron、AWS S3、七牛或者自定义，每个类型下的同步相关的信息数据独立存储，所以可以同时使用。
但一般情况下，并不是非常推荐这样的用法。

同步是自动的吗？

不是。是手动控制的。

同步后的文件是公开的吗？

具体视情况而定，比如七牛上的，这个控制权在账户上可以进行设定。
AWS S3 的同步是否公开，在 同步设置 中可以设定，但仅对设置之后的同步生效，默认为私有状态。
而 Bitcron 的公开还是私密，则有具体的网站上进行设定的。

同步重置是什么概念？

MarkEditor同步时，会保留一份当前同步状态的数据，同步重置就是清除这个状态，在下次同步的时候，就相当于重新同步。
在你更换了云端，或者云端的存储空间名等设置项，才有必要进行这个操作。

为什么有部分文件没有同步？

检查同步日志是否正常，如果不正常，请重新配置同步信息；如果正常，请同步重置，再进行一次同步即可。
通常是同步的配置失败，有部分文件尝试同步的时候虽然已经失败，但下次不会继续再参与同步。只有重置同步信息后，才会消除那部分文件的状态。

为什么不能获得同步后的网址？

在同步的相关配置里，需要补充可直接访问的域名地址。

为什么同步后获得的网址无法访问？

需要在云存储服务商(S3、七牛)上将对应的空间设置为公开的即可。

同步并获取网址，会替代本地的另外一个HTML文件？

比如hello.txt这篇文档，它会自动转义为hello.html，并进行同步。如果之前已经存在hello.html，那么它会被覆盖掉。

为什么更新文章后，获得的网址却没有变化？

可以查看同步日志，对应的HTML文件应该是已经同步完成，但是网页没有变化，很大原因是在于云存储的服务商(比如七牛)本身的缓存策略导致的。你可以在相关的设置里 (非MarkEditor提供的) 降低最小缓存时间，或者等待一段时间。

关联云端后，最终Markdown 编译 HTML 后的图片地址是什么规则？

图片的 URL 始终都是/xxxx.jpg类似的，而不会是http://domain.com/xxxx.jpg类似的。
前提是关联第三方商业云之后，并且有设定域名，那么一键获得 URL 的功能，实际上是将当前 Markdown 编译为 HTML 之后，再进行一次同步；图片本身在外部 URL 访问的时候是直接可以被访问到的。
唯一特殊的是“复制为富文本”的功能，会进一步尝试替换最终内容的 URL 为用户自行设定的域名，主要是考虑到 Email 发送等场景。

AWS-S3

2024-06-09T02:46:04Z

AWS S3 如何设置？

AccessKey & SecretKey

首先，登录 AWS 控制台，进入 S3，创建一个 Bucket，比如名为 test-for-markeditor。

然后，进入 IAM Manager，为自己要同步的 Bucket 创建 AccessKey & SecretKey。

最后，添加一个新的用户，最后，就可以得到这个账户对应的 AccessKey & SecretKey。

Bucket

自己选择要同步的 Bucket 的名称，比如之前步骤中自己新建的 Bucket test-for-markeditor。

Upload Publicly

如果勾选了，表示上传到当前 Bucket 的文件，都是公开的，只要访问到对应的 URL 就能看到。

Domain

一般就是 s3.amazonaws.com/ + Bucket，比如 s3.amazonaws.com/test-for-markeditor

注意事项

不要暴露自己的 AccessKey & SecretKey。
注意使用 AWS 服务的时候，应该使用 IAM 来控制不同 Bucket 上的权限问题。
虽然 MarkEditor 对 S3 的支持包括的 同步上去 以及 同步回来 两个逻辑，但推荐主要用途为备份使用。非常不推荐把这个支持当做类似 Dropbox 的网盘使用，实际的便捷性、可靠性、费用要远远超过个人网盘。

Custom FilesHook

2024-06-09T02:46:04Z

Custom & FilesHook 介绍

云同步 的自定义类型，也叫 FilesHook，就是每次同步的时候，在探测文件的变动后，调用特定的命令进行处理。
Command for Sync to: 同步到云端的命令
Command for Sync from: 从云端同步回来的命令，一般会留空
Delta File to Store: 会将当前文件的变动（增减行为）以 JSON 的格式，记录到这个指定的路径中 (可以留空)

于Jekyll之上，优秀的写作体验

如果你在用 Jekyll 之类的静态博客，并且成功搭建在 Github 上的，那么你使用 MarkEditor 的 FilesHook功能实现同步。
基本的逻辑: 在文件夹完成一次同步之后，检测到文件的变动，触发相应的脚本命令。

在 Jekyll 中，一般对应的 FilesHook是向 github 进行一次提交，自然也会完成一篇日志的修改、新增、发布。
所以，在自定义的同步设置，Command for Sync to 中填入如下内容：

## 一个发布到 Jekyll 的 hook 脚本命令 (仅供参考) ## 
cd $root$ && git add -A && git commit -am "update" && git push origin gh-pages

其中的 $root$ 最终在执行的时候，会被替换为当前目录的路径。

注意: FilesHook 是 MarkEditor 的一个底层调用接口，基本上可以认为是面向程序员的一个功能，但并非特定为 Jekyll 或 Github 提供的支持。若要用来发布 Jekyll，请确保自己已正常运行了 Jekyll，以及基本发布流程完全正常，git 提交本身不会产生冲突等等需要自行处理的事务……

般建议不要使用&符进行连续调用，而是自行增加一个运行的脚本(比如某个bat文件)来处理，或者直接触发其它脚本对sync_changes.log进行处理；但另外请注意，即使如此，也不能保证ME内的命令调用能正常运行，以实际情况为准。

某些情况，命令可以在Term、终端内运行，被FilesHook调用时却出现错误，可能是由于环境变量限制、缺失产生的，尝试输入命令对应的实际路径或许能解决问题。但另外请注意，即使如此，也不能保证ME内的命令调用能正常运行，以实际情况为准。