简述
用Typora写Markdown笔记的朋友,应该不少吧?
把笔记上传到博客园的朋友,应该也不少吧?
那么大家都是怎么把笔记上传到博客园的呢?手动复制不?
想不想一键导出笔记到博客园呢?支持分类
、标签
哦!
想就往下看!
本文内容可与我的另一篇文章Typora-Picgo搭配使用,实现Picgo图床分目录存储图片!
一键发布
想必大家自己找过很多一键发布的方法了吧,我找到过:
- donet插件:发现有文章介绍的这个,但只是上传图片用的,笔记内容还是得手动复制到博客园。而且博客园编辑页已经支持本地图片批量上传转换了,弃用此方法。
- MetaWeblog API:这个API是个业内规范了,基本博客网站都支持,包括CSDN、博客园等。
看到有个园友夜行过客
写了篇文章,通过这个API上传笔记。可惜,没介绍到怎么发布分类、标签。而且只有新建笔记的介绍,没有更新。
于是,本文就诞生了,站在前面这位园友的肩膀上,我们搞个全套实现!
安装Python
园友是通过Python脚本调用API上传的,所以我们需要先安装Python。
- Mac OS:自带python,无需额外安装
- Windows:进入官方下载页,选择稳定版,对应自己操作系统的,然后傻瓜式安装就好了。
开启MetaWeblog
进入博客园的设置页:
![image-20230103154901600](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103154901600.png)
划到最后的其他设置,勾选允许MetaWeblog访问:
![image-20230103155015203](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103155015203.png)
然后点击访问令牌的"查看",无则新建。
暂记下这里的MetaWeblog登录名、访问令牌、访问地址,要配置在本地的。
看到上图中的推荐客户端了么,Open Live Writer?当初想看看这个客户端是否支持笔记的分类、标签,就点开看看了:
![image-20230103155318124](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103155318124.png)
看到没有,这里有篇文章介绍了客户端是支持分类、标签的!点开文章看到:
![image-20230103155538166](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103155538166.png)
客户端也是通过API发布文章的,既然他可以,那我们也可以通过自定义脚本实现!
上图里类别、标签的名字分别是Categories、Keywords,点开我们前面其他设置
中的MetaWeblog访问地址,查看API介绍:
![image-20230103155846494](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103155846494.png)
我们点击新建文章的API名字,看到其参数有:
![image-20230103160022749](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103160022749.png)
其他参数没什么,关键就是这个post参数了,点击前面的链接,查看其结构:
![image-20230103160417970](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103160417970.png)
前面必填的3个参数分别是发布时间、文章内容、文章标题。
然后与客户端一样,有带category、keyword字样的参数,就是图里标出来的俩。那肯定是你们了,哼哼!
至此,我们可以大致有个实现思路了:通过Python脚本,调用API,发送参数里给定分类、标签就行啦!
配置文件
创建一个配置文件cnblogs.ini,内容为:
[server]
url = xxx
username = xxx
password = xxx
[category]
mdjfsmf2yq = [随笔分类]Java
[keyword]
mdjf5pww5o2u5bqt = 数据库
[blogid]
l1vzzxjzl3n0yxj0b25nl1dvcmttcgfjzs9t = 17013320
这里有四部分:
-
server:博客园中设置的MetaWeblog登录信息
-
category:分类的设置。
-
键:我用了笔记第一层目录的base64码。
如笔记文件全路径为/pardir/Java/语法/基础语法.md,去掉前面的通用笔记路径/pardir后,第一层路径为Java,将Java转为base64码后,作为键。
使用base64编码,是为了防止自建的目录中包含空格等特殊字符。 -
值:固定格式为
[随笔分类]
+自定义分类名中间不要有空格。
可以不在博客园中预先定义好,API会自动创建!
至于为什么用随笔分类,因为测试过其他值,发现不能发布为文章。
可以用个脚本获取所有分类:import xmlrpc.client import ssl import configparser ssl._create_default_https_context = ssl._create_unverified_context # 读取配置文件 config = configparser.ConfigParser() # 获取解析器 config.read("/xxx/cnblogs.ini") # 读取配置文件内容 # 获取配置中的博客园登录信息 url = config.get("server", "url") username = config.get("server", "username") password = config.get("server", "password") # 调用类别查询API proxy = xmlrpc.client.ServerProxy(url) categories = proxy.metaWeblog.getCategories("", username, password) print(categories)
-
-
keyword:标签的设置
- 键:与类别一样,只是用了第二层目录值
- 值:随便自定义
-
blogid:存了每笔文章的ID。用来判断文章是新建,还是更新。
- 键:与类别一样,只是用了去掉父目录后的剩余全部字符串
- 值:首次发布成功后,自动填入
编写脚本
上传脚本
基于前面园友已有的脚本,我们改造成了upload_to_cnblogs.py:
import xmlrpc.client
import ssl
import os
import sys
import configparser
import base64
ssl._create_default_https_context = ssl._create_unverified_context
# 读取配置文件
rootPath = os.path.abspath(os.path.dirname(__file__)) # 获取当前路径
config = configparser.ConfigParser() # 获取解析器
config.read(os.path.join(rootPath, "cnblogs.ini")) # 读取配置文件内容
if __name__ == "__main__":
# 获取配置中的博客园登录信息
url = config.get("server", "url")
username = config.get("server", "username")
password = config.get("server", "password")
# 设置Base64编码的+/替换符
altchars = bytes("Xx", encoding="utf-8")
# 获取参数
fileName = sys.argv[1]
parMkdPath = sys.argv[2]
# 获取分类
markdownDir = fileName.replace(parMkdPath, "").lstrip(os.path.sep)
markdownDir = markdownDir.split(os.path.sep)
category = base64.b64encode(bytes(markdownDir[0], encoding="utf-8"), altchars)
category = bytes.decode(category).rstrip("=")
keyword = base64.b64encode(bytes(markdownDir[1], encoding="utf-8"), altchars)
keyword = bytes.decode(keyword).rstrip("=")
validateFlag = True
# 分类维护时
if not config.has_option("category", category):
validateFlag = False
print(f'目录({markdownDir[0]}, base64码: {category})未维护对应分类!')
if not config.has_option("keyword", keyword):
validateFlag = False
print(f'目录({markdownDir[1]}, base64码: {keyword})未维护对应标签!')
if validateFlag:
# 获取编码后文件名对应博客ID-读自配置
category = config.get("category", category)
print(category)
keyword = config.get("keyword", keyword)
print(keyword)
# 文件名用Base64编码
fileNameEnc = base64.b64encode(
bytes(fileName, encoding="utf-8"), altchars)
fileNameEnc = bytes.decode(fileNameEnc).rstrip("=")
# 获取文件内容
with open(fileName, "r", encoding="utf8") as f:
data = f.read()
# 获取文件名
title = os.path.basename(fileName)[:-3]
post = dict(
dateCreated=xmlrpc.client.DateTime(),
description=data,
title=title,
categories=["[Markdown]", category],
mt_keywords=keyword,
)
proxy = xmlrpc.client.ServerProxy(url)
# 若有博客ID,则使用editPost API编辑
if config.has_option("blogid", fileNameEnc):
# 获取编码后文件名对应博客ID-读自配置
blogId = config.get("blogid", fileNameEnc)
s = proxy.metaWeblog.editPost(
blogId, username, password, post, True)
# 若无博客ID,则使用newPost API新建
else:
blogId = proxy.metaWeblog.newPost(
"", username, password, post, True)
if len(blogId) > 0:
config.set("blogid", fileNameEnc, blogId)
# 输出文章连接
userName = url.split("/")[-1]
print(f"https://www.cnblogs.com/{userName}/p/{blogId}.html")
# 写入配置信息
cfgWrite = open(os.path.join(rootPath, "cnblogs.ini"), "w")
config.write(cfgWrite)
cfgWrite.close()
大致逻辑:
- 获取传入的参数:Markdown笔记全路径、父路径。
参数传递下文会介绍。 - 笔记全路径去掉父路径后,取得剩下的第一层、第二层路径、全部路径,分别用Base64编码,去掉最后的"=",作为键,获取配置文件中对应的分类、标签、文章ID。
- 设置API参数:文章标题、文章内容、发布时间
- 根据文章ID是否存在,调用创建或更新API。
若为创建,则根据API返回值,将文章对应ID写入配置文件。 - 最后输出文章链接。
试过加入校验不通过时,如分类配置未维护,主动以错误状态退出sys.exit(1)
,结果Typora端触发发布文章时,什么提示都没有了。。。。
所以脚本里将错误输出到控制台了,不定义异常抛出。
调用脚本
在Typora中第一步调用的脚步,设置成了另一个shell脚本。主要是为了与我的Picgo图床同步。
我的另一篇文章中介绍了Picgo+阿里云图床的设置,上传的图片按笔记路径存储,但是云端这样分类了,本地还是没有。所以在上传笔记前,做了份脚本移动图片目录。
如果无此需要,可以跳过本节。
shell脚本upload_to_cnblogs.sh:
MKD_FILE_PATH=$1 #获取Markdown文件全路径
FILE_NAME=${MKD_FILE_PATH%.*} #删除最后一个“及右侧内容
FILE_NAME=${FILE_NAME##*/} #删除最后一个"及其左侧内容,获取所有图片父路径
PAR_IMG_DIR=$(cat ~/.picgo/config.json |grep img_ignore_path) #获取图片路径配置
PAR_IMG_DIR=${PAR_IMG_DIR%\"*} #删除最后一个“及右侧内容
PAR_IMG_DIR=${PAR_IMG_DIR##*\"} #删除最后一个"及其左侧内容,获取所有图片父路径
PAR_MKD_DIR=$(cat ~/.picgo/config.json |grep mkd_ignore_path) #获取Markdown路径配置
PAR_MKD_DIR=${PAR_MKD_DIR%\"*} #删除最后一个“及右侧内容
PAR_MKD_DIR=${PAR_MKD_DIR##*\"} #删除最后一个"及其左侧内容,获取Markdown父路径
EXTRA_DIR=$MKD_FILE_PATH #获取Markdown文件全路径
EXTRA_DIR=${EXTRA_DIR%/*} #删除最后一个/及右侧所有字符串
EXTRA_DIR=${EXTRA_DIR#$PAR_MKD_DIR} #删除父级Markdown目录
if [[ ! "$MKD_FILE_PATH" =~ ^"${PAR_MKD_DIR}".* ]]; then
echo "Markdown文件路径与插件配置的父路径不一致!"
exit 1
fi
if [ ! -e $PAR_IMG_DIR$EXTRA_DIR ]; then
mkdir -p $PAR_IMG_DIR$EXTRA_DIR #创建与Markdown相同结构的目录
fi
if [ -e $PAR_IMG_DIR/$FILE_NAME ]; then
cp -R $PAR_IMG_DIR/$FILE_NAME $PAR_IMG_DIR$EXTRA_DIR #移动图片至新层级下
rm -r $PAR_IMG_DIR/$FILE_NAME
fi
python3 ~/WorkSpace/Scripts/Typora/upload_to_cnblogs.py $MKD_FILE_PATH $PAR_MKD_DIR #上传至博客园
大致逻辑:
- 读取Picgo设置文件中的笔记、图片父路径值
- 笔记全路径去掉父路径、文件名,剩下分类路径
- 根据分类路径,在图片父路径下创建子目录
- 将原来的图片目录复制到新的子目录下,然后删除原来的目录
- 调用python脚本,上传笔记到博客园
配置Typora
在Typora的导出类型中,新增一个自定义的:
![image-20230103174458068](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103174458068.png)
新的导出类型命名为CNBlogs,右侧的命令设置为upload_to_cnblogs.sh ${currentPath}
:
![image-20230103174715128](https://star-pb.oss-cn-shanghai.aliyuncs.com/mkd/30_%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83/01_%E7%AC%94%E8%AE%B0%E8%BD%AF%E4%BB%B6/Typora-%E5%8D%9A%E5%AE%A2%E5%9B%AD/image-20230103174715128.png)
${currentPath}为Markdown全路径文件名。
如果没有我上一小节的需要,这里的命令改为python3 /xxx/upload_to_cnblogs.py $currentPath
即可。
可以点击设置中的上下箭头,移动导出类型的显示顺序哦。
测试发布
写完一篇笔记后,点击菜单栏的导出到CNBlogs:
![image-20230103175610706](../../img/Typora-博客园/image-20230103175610706.png)