前言
国庆节写了一个新的编辑器主题也成功上线了,也就是这篇文章的主题,评论区里很多小伙伴都说需要教程,今天就带来一个全流程图文教程。
简单说一下需要什么:
创建项目
- 打开掘金官方的模板,点击绿色的
Use the template
按钮:
点击之后会让你新建一个仓库,命名尽量使用 juejin-markdown-theme-你的主题名,然后点击绿色的创建即可:
创建好之后,我们就可以用 git clone 或者编辑器的图形化界面来把项目克隆到本地:
- 因为git在国内时常抽风,这里给大家推荐一个软件dev-sidecar: github 加速, git clone加速,google CDN加速,Stack Overflow加速。
- 我这里使用
git clone
和vscode编辑器,打开命令行输入:
第一步就完成了:
开始Coding
- 先修改
LICENSE
,容易忘掉(json文件可以自己修改或者删掉,我是直接删掉了):
- 掘金给出了主题开发工具,可以在命令行输入:
cd <yourThemeProject> npx juejin-theme-devtool <yourStyleFile> 复制代码
- 就像这样:
打开 http://localhost:3000 就可以修改同时预览了:
- 然后就可以开始写代码了,可以使用CSS或SCSS,推荐使用SCSS(省事儿,还没有什么学习成本),可以在模板基础上一点点修改,也可以把别人的下载下来参考,比如mancuoj/Chinese-red。
- 找颜色,改样式,看预览三步循环🔥
- 写完之后,觉得预览效果可以了,就可以推送到Github仓库了(不赘述了)。
提交PR
fork
一下掘金官方仓库,然后克隆到本地修改,或者直接网页中修改也行。
修改 theme.js,添加下列几项,其中 highlight 可省略,别忘了逗号:
ref 是你的主题仓库上传生成的 commit hash 值:
在 README.md 中添加你的大名,照着上面写就行了,仓库地址+掘金主页+MIT:
然后就可以提交pr了,打开你fork来的仓库点击 Pull requests:
直接合并到 main
,填写一下描述,就是新增了xx主题:
打开官方仓库就可以看到你的pr了:
需要通过一些自动的check来检验你的成果:
检测不成功会出现×,这时候你就需要对比其他通过的PR来修改了:
同时也可以点击 Details 来查看部署的结果:
修改 front-matter 就可以看到了
接下来就是等待大佬来 merge
了。
参考主题列表
参考主题 | 作者 |
juejin | |
smartblue | Tusi |
cyanosis | 林小帅 |
少数派 (sspai.com) | |
typora-theme-misty | etigerstudio |
typora-theme-pie | kevinzhao2233 |
typora-theme-ursine | noatpad |
My-Typora-Themes | Theigrams |
DrakeTyporaTheme | liangjingkanji |
typora-vue-theme | blinkfox |
hydrogen | DawnLck |
fancy | xrr2016 |
Chinese-red | Mancuoj |
一些坑
开发工具预览
跟PR中的预览
跟实际上线后
的三个样式都会有一些细微差别,尽量使用px来作为单位,而不是rem或者em。- 需要注意
行间代码
及代码框
的区别。 - 任务列表
- [x]
语法需要格外注意,我就是前车之鉴。 - 表格样式以及在黑暗模式下的显示。
- 字体样式及大小。
- 提交PR后进行的修改,需要同步修改
commit hash
。 - 尽量要做到清爽,不要太花哨,考虑一下整体的兼容性,背景图片什么的能省则省。
- PR通过后,掘金线上编辑器是有这个主题了,但是文章没有效果,需要等官方发版,具体发版时间未知(我是中午可以在线上编辑器看到,晚上就能使用了)。
- 不能有外链,也不能使用特殊字体,背景图片必须是
base64
格式的。 - 提交PR的时候合并成单条commit记录,不建议连历史一起提交,我是第一次不懂,一直在修改,可以在同一个commit下提交。
- 还有一些想到再补充😊
总体还是挺简单的,希望大家多多贡献,也能让我有更多选择。
我是Mancuoj,如果还有什么疑问或者踩了什么坑可以评论留言,我都会回复的,求个赞👍