使用Typora+PicGo+Gitee打造全新Markdown博客创作环境
[TOC]
第一部分:概述
1.1 问题来源
工欲善其事,必先利其器。
本文主要解决markdown图片自动上传个人托管平台,并以链接形式记录在markdown中,提高markdown复用性的问题。
很多领域作者喜欢使用Markdown格式文本进行创作,这是一种轻量级的标记语言,具有以下几个显著优点:
- 编写方便,语法规则简单易懂。
- 支持多种对象类型,例如编号,图片,图表,数学公式等。
- 支持多平台,尤其对于html兼容,很适合写在线帮助文档或者论坛博客知识共享。
对于图片类型的对象,在markdown中记录时,常常需要指定图片的本地或在线路径,这就带来一些问题:
- 如果采取本地图片路径,则对于知识共享很不方便。
- 如果采用远程url图片路径,则需要先将图片上传网络,然后粘贴图片的站外链接。
- 如果创作者需要将文章发布在多个平台,则需要重复上传,这是一件令人费力的事情。
为了解决上述问题,最好的办法是将图片变成一个个链接,用引用图片url的方式写在markdown文本中,这样一来,只要浏览文章的主机可以连网,那么不论在哪个平台,都可以在编辑器中看到markdown中渲染的图片,这是创作者尤其是喜欢在多个平台共享知识的创作者的福音。
使用Typora+PicGo+Gitee可以实现上述操作,Typora是编辑器,PicGo是图床,可以建立编辑器与托管平台的连接,Gitee是图片托管平台,读完本文之后,读者可以有以下收获:
- 实现markdown中的图片自动上传托管平台,并在文档中将本地图片自动转化为远程图片URL路径。
- 实现文档的多平台兼容共享,尤其是在展示图片时。
- 文档中的图片免费托管,且所有图片均在用户账户下,可以随时下载或者查看。
本文适合以下用户:
- 准备进行博客创作的小白
- 需要提高创作效率的领域作者
- 希望解决markdown图片上传与备份问题的其他用户
1.2 软件简介
Typora:是一款轻便好用的Markdown编辑器,支持实时渲染,没有采用源代码和预览双栏显示,采用“所见即所得”的设计模式。笔者选择它的理由主要有三个:
- 写下来的文字就是渲染后的样子,跟word很像,简单易用。
- 大纲目录展示功能,并且可以分层级进行模块折叠,这对于写长篇文章或帮助创作者理清思路很有帮助。
- 功能多样,支持丰富的段落模式,以及PDF等多种格式的导出文件。
PicGo:一个用于快速上传图片并获取图片URL链接的工具,支持多种图床,在本文中,我们用到的是Gitee图床。相关特性可以移步到官网。可以作为连接编辑器和图片托管平台的工具。
Gitee:目前国内最大的代码托管工具,同时也支持图片的上传,有点像Github。笔者尝试过类似七牛云或者BAT等云的托管平台,发现还需要购买个人域名或存储空间,比较麻烦,相比之下,Gitee做的很优秀。
第二部分:实现
2.1 软件下载
Typora的下载安装和激活可以参考这篇文章或者其他博客,这里主要介绍PicGo的安装过程。
打开Typora,依次单击菜单栏【文件】=>【偏好设置】=>【图像】,会在页面上展示【下载PicGo】按钮,单击即可跳转下载页面。因为这里笔者做了主题颜色的修改,所以软件的背景是深色的,这个基本不影响本文的阅读。
在下载页面中单击【免费下载】,会跳转到github相应网站,下拉可以看到下载链接:例如笔者选择【PicGo-Setup-2.3.1.exe】这一项。
接下来就是程序安装过程,可以自定义程序的安装路径,这些操作比较简单。
注意如果想要正常使用PicGo,可能还需要安装NodeJS环境,可以下载左侧稳定板,这个过程也是按部就班,按照提示进行安装即可。
以上软件安装完毕后,就可以进行仓库的创建。
2.2 GiTee账户令牌与仓库创建
Gitee账户的准备工作有以下几项工作需要做:
- 创建账户
- 创建项目(也就是仓库)
- 修改仓库权限为公开
- 生成私人令牌
如果读者还没有Gitee账户,需要先创建Gitee账户,如果已有账号,可以直接登录。
然后需要创建一个公开仓库,按照以下操作进行配置。
首先新建仓库
配置仓库相关参数,这里暂时还不能修改仓库权限。
新版Gitee无法再创建时选择权限,需要创建后在仓库设置中选择公开。在仓库界面单击选择【管理】,并且勾选相关单击【确定】。
进入仓库主页。
进入仓库设置页面。
设置仓库权限为开源。
接下来需要设置私人令牌,这个令牌相当于暗号或者密码,外部可以通过这个另外访问到当前账户下的数据,注意明文令牌只展示一次,需要及时保存在粘贴板中,后续要用到。
进入个人主页设置。
在设置页面左侧找到【私人令牌】。
添加私人令牌。
配置私人令牌参数。
注意令牌明文只展示一次,需要记录下来,后面要用。
到此为止,Gitee仓库创建完成,个人的令牌也已经生成,接下来就是要把账户(Gitee用户名和仓库名)和密码(私人令牌)写在PicGo中。
2.3 PicGo配置工作
打开PicGo软件,做必要的安装配置。
- 安装gitee-uploader插件
- 设置gitee相关账户、仓库和令牌
- 设置PicGo软件
首先需要在【插件设置】中安装gitee插件,搜索gitee-uploader并单击安装,等待几分钟安装完毕。
安装后重启PicGo,可以在【图床设置】选项中看到下拉选项【Gitee】,单击并进行配置。
有以下几项:
- repo:在自己的Gitee账户下,单击刚刚创建的根目录,在浏览器的当前页面链接中复制最后的账户名和仓库名部分,例如笔者的这一栏填“softargmax/blog-pic”。
- branch:一般选择master
- token:刚才在剪贴板中粘贴的私人令牌,直接复制过来
- 其他:保持默认即可
注意账户名和仓库名要粘贴红色框里面的。
配置完毕后,单击【设为默认图床】和【确定】
对PicGo进行一些其他的设置,正常情况下,【设置Server】中的监听网址保持默认就好。
在设置server中,默认应该是这样的IP配置,如果不是就修改成这样。
2.4 Typora配置工作
这是最后一步,配置Typora,主要有以下工作:
- 设置插入图片的时执行的操作为【上传图片】,并设置相应动作
- 配置上传服务为PicGoAPP,并且选择程序所在的安装路径
- 单击相应按钮进行验证测试
返回刚才打开的PicGo的偏好设置,在【图像】界面进行设置:
设置完成后,可以单击【验证图片上传选项】按钮,证实自己的操作是正确的。
如果出现红色的faild字样,说明以上配置存在错误,可以从以下几个方面排查:
- 检查仓库的权限是否被修改为公有
- 检查PicGo中的Gitee配置是否和账户中的情况一致,尤其是账户名和仓库名要选择从链接中粘出来的而不是别的
- 重启各个软件再次尝试。
如果提示出现successful字样,则说明上述配置成功。具体使用时,有以下现象:
- 在使用Typora编写markdown文档时,不论以何种方式(例如选择本地文件或者其他网页的url文件)添加图片,图片都会自动上传到自己Gitee账户下的仓库中,并且在markdown中将链接地址修改为该图片的Gitee外往访问链接,这些链接是可以通过python或其他方式进行自动爬虫同步本地的,当然也可以自己登录仓库下载,也就意味着本地不需要再保存markdown中用到的图片了。
- 打开仓库,可以看到按照时间戳排序的各个图片文件,可以供用户批量下载备份。
- 在PicGo的【相册】栏目中也会出现通过该软件上传过的图片。
第三部分:总结
3.1 关于创作
本文主要解决使用markdown编写文档时,图片的自动上传和备份问题。读者可以通过以上方式初步搭建自己的创作平台,方便自己的文章在各个平台进行备份,并且保证自己的创作的文章中的各个元素尤其是图片不丢失。
本文基于一些现有的博客进行改写,所以需要感谢这些前辈提供的宝贵思路,本文创建于2022年底,后续随着各个软件的版本更新,难免会有一些操作和本文不一致的地方,但是大体上流程和本文是一致的,本文的所有操作流程都是笔者亲身实践,如有谬误或不全面的地方,欢迎读者多多指教。
希望这篇文章可以帮助到有需要的读者。
3.2 本文修订记录
修订时间 | 修订人 | 修订类型 | 修订原因 |
---|---|---|---|
20221115 | softargmax | 文档创建 | 文档创建 |
20221116 | softargmax | 文档修改 | 增加部分图片,修改错别字 |
3.3 本文所使用的各个软件版本
Typora:1.0.3
PicGo:2.3.1
Gitee:网站形式,20221115版