bilibili-zhuanlan-markdown-tool v1.0.6
Bilibili zhuanlan Markdown-Tool
这是一款可以让你使用Markdown
文本标记语言撰写哔哩哔哩(bilibili.com)专栏文章的辅助工具。
Usage(使用说明)
本机安装
Node.js
环境,获取项目源码,npm install
安装依赖。取得用户认证
cookies
,写入配置文件。使用
Markdown
写作。使用前端窗口或命令行接口提交
Markdown
文章。
Work Flow(工作原理)
B站专栏文章使用HTML
对专栏文章进行存储与展示。无论是使用B站富文本编辑器还是Markdown
,最终都会转换为HTML
上传至B站服务器保存,并在用户需要时调取展示。
此工具完成的任务,便是将Markdown
转换为Bilibili Compatible HTML
,再自动上传至B站服务器。
图:工作原理示意图
Example(实例讲解)
下面通过一个实例,详细讲解如何使用此工具。
步骤1 - 安装环境与获取源码
此工具使用Node.js
写成,要想使用它,需要先在本机上安装好Node.js
环境。
Node.js
官网:https://nodejs.org/
获取 GitHub 上的项目源码,可以使用git clone
,也可以直接下载zip
压缩包。对于Node.js
项目,我们一般使用npm install
来安装项目依赖。
步骤2 - 获取关键参数写配置文件
这是至关重要的一步。我们需要手动取得关键参数cookies
写入配置文件。cookies
是用户个人身份认证信息。此工具依赖该参数与B站专栏服务器正常通信。
我们可以使用Chrome开发者工具获取该参数。具体步骤如下:
- 前往B站AJAX快速登录页
- 打开Chrome开发者工具 >> 网络侦测器
- 填写B站登录信息与验证码
- 从跨域跳转响应页中取得
cookie
参数
图:获取
cookies
参数
将取得的关键参数写入到config/config.json
配置文件中,格式可参看配置选项。
步骤3 - Markdown 写作
至此,所有准备工作均已完成。我们可以告别B站专栏富文本编辑器,转而使用Markdown
撰写文章了。拿起你最钟爱的一支Markdown
编辑器,愉快地写文章吧。
图:撰写
Markdown
文章
步骤4 - 提交文章
文章写完,我们将这篇Markdown
格式的文章变身成为B站专栏文章。
工具提供两种提交接口: 前端窗口提交与命令行提交。
提交成功后,我们可以回到B站专栏草稿箱看看。Markdown
格式的文章已经变身成为B站专栏文章了,排版、样式准确,静静地躺在专栏草稿箱中,专栏文章的标题是Markdown
文件名。
前端窗口提交
我们运行命令来启动工具前端窗口,键入Markdown
文件「绝对路径」,点击提交按钮。如果反馈成功,则说明提交成功。
$ npm run server
代码清单:启动工具前端窗口
图:工具前端页面
图:提交成功反馈页面
命令行提交
使用命令行(CLI)提交则更加简洁明了,还可以配合脚本实现批量化。
# 绝对路径 or 相对路径均可
$ node src/cli.js <path/to/your/markdown/file>
代码清单:使用工具命令行(CLI)接口
发布前准备工作
预览文章、添加头图、选择分类、撰写专栏推荐语,这些都是文章发布前的准备工作,手动完成后就可以提请发布文章了,当然,B站要审核文章的。目前,B站专栏还不支持修改发布后的专栏文章。
图:由
Markdown
变身的专栏文章「网页端预览」
Attentions(注意事项)
这里有一些注意事项你一定要了解。
不支持的 Markdown 语法
目前,B站专栏所能提供的功能选项还非常有限,甚至连Markdown
基本语法标准都无法达到完全支持。对于下列Markdown
语法项(甚至是常用选项),B站专栏目前还无法提供支持。对于扩展Markdown
功能,更是没有可能。
- 六级标题「可用」
- 斜体文本
- 外部超链接「可用」
- 外链图片「可用」
- 行内代码「可用」
- 代码块「可用」
- 表格
- 内联HTML
# 六级标题
#
##
###
####
#####
######
# 斜体文本
*text* _text_
# 外部超链接
[alt](http://xxx.xxx.xx)
# 外链图片
![alt](http://xxx.xxx.xx)
# 行内代码
`code`
# 代码块
```code blocks```
# 表格
|---|---|
# 内联HTML
<div>
</div>
注:标注为「可用」的语法项其实B站专栏后端也是支持的,只是B站没有开放
如果你考虑将Markdown
文章发布到B站专栏上,请谨慎使用上述语法格式,并考虑替代方案「如:使用图片替换表格」。
专有功能
另外,B站也针对自家的专栏文章平台添加了一些专有功能,这些选项大多含有B站特色。
- 字号
- 对齐
- 颜色
- 图片分割线
- 站内选项卡
这些选项大多没有合适的Markdown
语法与之对应,实现方式只能通过内联HTML。
分析B站专栏文章页面结构,这些专有功能大多是通过class样式 + 行内css样式
实现,并不具备可移植性,也不符合结构与样式分离原则。
此工具并不对这些专有功能提供支持。
当然,如果你想为你的Markdown
文章添加上B站专有功能,完全可以在使用此工具提交后,回到B站专栏富文本编辑器中手动修改。
Configurations(配置选项)
此工具的json
配置文件非常简单,取得个人用户的cookies
填入即可,就像这样:
{
"cookies": ""
}
更加详细的说明:
cookies => 以下 Cookie 必需,有效期大约半月(过期重取)
"sid"
"DedeUserID"
"DedeUserID__ckMd5"
"bili_jct"
"SESSDATA"
Development(开发相关)
集成该工具开发,需要先npm install
安装,再导入bilibili-markdown-tool
模块。
$ npm install bilibili-markdown-tool --save
API | 说明 |
---|---|
startProcess(markdown_path, config_object) | 上传Markdown 文件至B站专栏草稿箱,接受Markdown 文件路径与用户自定义配置选项 |
表:模块
API
接口表
Dependences(依赖相关)
A markdown parser and compiler. Built for speed.