写作工具配置:Typora + PicGo + GitHub 图床 + Textlint

本文最后更新于:2021年6月10日 下午

工欲善其事,必先利其器

写作指南

写作工具

  • 支持 Markdown 的文本编辑器
    • 常见的文本编辑器如 VS Code 、Sublime Text 都可以原生或者通过扩展支持 MarkDown。也可以选择专门的 MarkDown 编辑器:7款好用的 MarkDown 编辑器推荐
    • 选择文本编辑器写作,就必须要熟悉 MarkDown 的语法。好在 MarkDown 的语法比较简单,号称五分钟就能上手,剩下的就多写多练了。
  • 富文本编辑器
    • 语雀、简书等
    • 这里所说的富文本编辑器主要指所见即所得,无须使用 MarkDown 语法就可以使用的编辑器,一般是在线编辑器。好像曾经有道云笔记曾经支持过,但是现在已经没有了。现在可以选择的有简书(好像也差不多没法用了)和语雀。好处是可以省掉学习 MarkDown 语法的过程。而且一般还有一些功能上的扩展,比如贴图即上传到对应服务器的图床上。如何解决图床问题也是博客写作的一个门槛,但是使用富文本编辑器就可以直接上传到对应编辑器的服务器上。

工具选择

之前在阿里工作的时候,内部就使用过语雀,用的还比较习惯。也看到有人写平时都用语雀编辑完导出再上传到博客。不过都已经开始自己折腾了博客了,这样搞感觉还不如就拿语雀做笔记了,导来导去有点多此一举。我也有心想学一下 MarkDown。

综合各种推荐,特别是 Mac 环境下,最终选择 Typora 做编辑器。Typora 最大的特点就是可以所见即所得,另外对图片插入支持较好。除此之外的其他特点可以参考介绍:Typora 完全使用详解官网

MarkDown 语法

排版

排版主要参考:中文文案排版指北

在写作时需要在全半角符号之间大量添加空格,手动添加可能会累死。因此需要一款工具可以自动添加空格,目前使用的是 Textlint。

Textlint 安装:

npm install textlint --global
npm install textlint-rule-ja-space-between-half-and-full-width --global
textlint --init

会在当前目录生成 .textlintrc 文件,更新为以下内容。

{
    "filters": {},
    "rules": {
        "ja-space-between-half-and-full-width": {
            "space": "always"
        }
    }
}

使用 Textlint 检查:

textlint *.md

使用 Textlint 自动修复:

textlint --fix *.md

图床

MarkDown 写文档要想写的爽,另外一个要解决的问题就是如何插入图片。可以选择直接在资源目录下配置图片,用相对路径访问,而更好的解决方式是使用图床。图床的选择又是个纠结的过程,下面会结合使用的工具介绍如何选择。

图床选择

简单的说如果想免费,博客又选择备案的情况下最推荐使用的是七牛云。如果想免费,又不想备案,一般会推荐使用一些久经考验的公共图床。当然公共图床也可以有会员服务。还要考虑访问问题,国内的图床服务基本上都必须备案,而很多海外用的多的图床又被墙了。备案的问题也有解法,但是我不想搞这么复杂。

比较推荐的公共图床有 sm.ms 和路过图床。公共图床的问题就是说不定哪天就没了或者被墙了。不过国内的互联网的互联网服务,又何尝不是说没就没呢?互联网没有永恒。

在纠结中发现有的图床工具内置支持的上传图床有 GitHub。GitHub 不是最被推荐的选择,主要问题和用 GitHub 搭博客一样,国内访问慢,有被墙的风险。不过既然我的博客已经是搭在 GitHub 上了,图床也用博客至少能保证图床不会比博客先挂。我的博客也不想要做成什么吸引访问的站点,主要是用作整理记录而已。因此最后选择用 GitHub 搭建图床。如果以后博客想更新换代或者去做备案了,到时候再更换图床吧。

再说一下选择的图床工具。基本上最推荐的工具就俩,iPic 和 PicGo。iPic 原来几乎是 Mac 下的最佳选择,久经考验。并且可以和 Typora 集成,在 Typora 中粘贴图片可以自动上床到图床。但是除了默认图床(似乎是已经用不了的微博图床),想选择使用其他图床需要付费。PicGo 也是很多人推荐的,并且是开源且免费的。在最近的版本更新中 Typora 也集成了使用 PicGo 做图像上传服务,内置的图床又已经配好了 GitHub。那我想就无须再纠结,就使用 PicGo + GitHub 做图床好了。

GitHub 配置

  1. 创建 Repository

    创建Repository

  • 仓库最好是public的,因为private的仓库,图片链接会带token,这个token又存在过期的问题。
  • 为repository初始化一个README.md文件可以根据需求选择,非必选
  1. 获取授权 token

    操作路径:Settings / Developer settings / Personal access tokens / Generate new Token。token 只会显示一次,注意保存。

    获取授权 token

PicGo 配置

  1. 下载安装 PicGo 后运行。

  2. 配置图床

    PicGo 配置图床

  1. 图床 CDN 配置

    使用 jsDelivr 做图床 CDN,设定自定义域名为https://cdn.jsdelivr.net/gh/用户名/图床仓库名

  2. 其他配置

    PicGo 设置

Typora 配置

偏好设置 / 图像 / 上传服务设定中选择 PicGo,点击“验证图片上传选项”后提示成功即配置成功。

Typora 配置 PicGo

Typora 粘贴图片

直接粘贴图片至文档中,会显示文件名和本地路径。Typora 自动调用 PicGo 上传图片至图床成功后会将本地路径替换为图床返回的链接地址。