它来了!掘金编辑器主题开发贡献图文教程

简介: 它来了!掘金编辑器主题开发贡献图文教程

前言


国庆节写了一个新的编辑器主题也成功上线了也就是这篇文章的主题,评论区里很多小伙伴都说需要教程,今天就带来一个全流程图文教程。


简单说一下需要什么:

  1. Node.js
  2. Git
  3. 任意编辑器
  4. 一点点CSS基础+一点点审美+一点点模仿再创新的能力


image.png


创建项目



  1. 打开掘金官方的模板,点击绿色的 Use the template 按钮:


image.png

点击之后会让你新建一个仓库,命名尽量使用 juejin-markdown-theme-你的主题名,然后点击绿色的创建即可:


image.png


创建好之后,我们就可以用 git clone 或者编辑器的图形化界面来把项目克隆到本地:


image.png




image.png


第一步就完成了:

image.png


开始Coding



  1. 先修改 LICENSE,容易忘掉(json文件可以自己修改或者删掉,我是直接删掉了):


image.png


  1. 掘金给出了主题开发工具,可以在命令行输入:


cd <yourThemeProject>
npx juejin-theme-devtool <yourStyleFile>
复制代码


  1. 就像这样:

image.png

打开 http://localhost:3000 就可以修改同时预览了:


image.png


  • 然后就可以开始写代码了,可以使用CSS或SCSS,推荐使用SCSS(省事儿,还没有什么学习成本),可以在模板基础上一点点修改,也可以把别人的下载下来参考,比如mancuoj/Chinese-red
  • 找颜色,改样式,看预览三步循环🔥
  • 写完之后,觉得预览效果可以了,就可以推送到Github仓库了(不赘述了)。


image.png


提交PR



  1. fork一下掘金官方仓库,然后克隆到本地修改,或者直接网页中修改也行。


image.png


修改 theme.js,添加下列几项,其中 highlight 可省略,别忘了逗号:


image.png


ref 是你的主题仓库上传生成的 commit hash 值:


image.png


在 README.md 中添加你的大名,照着上面写就行了,仓库地址+掘金主页+MIT:


image.png

然后就可以提交pr了,打开你fork来的仓库点击 Pull requests:


image.png



直接合并到 main ,填写一下描述,就是新增了xx主题:


image.png


打开官方仓库就可以看到你的pr了:


image.png


需要通过一些自动的check来检验你的成果:


image.png


检测不成功会出现×,这时候你就需要对比其他通过的PR来修改了:

image.png

同时也可以点击 Details 来查看部署的结果:


image.png


修改 front-matter 就可以看到了


image.png


接下来就是等待大佬来 merge 了。


image.png



参考主题列表


参考主题 作者
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


一些坑


  1. 开发工具预览PR中的预览实际上线后 的三个样式都会有一些细微差别,尽量使用px来作为单位,而不是rem或者em。
  2. 需要注意 行间代码代码框 的区别。
  3. 任务列表- [x] 语法需要格外注意,我就是前车之鉴。
  4. 表格样式以及在黑暗模式下的显示。
  5. 字体样式及大小。
  6. 提交PR后进行的修改,需要同步修改 commit hash
  7. 尽量要做到清爽,不要太花哨,考虑一下整体的兼容性,背景图片什么的能省则省。
  8. PR通过后,掘金线上编辑器是有这个主题了,但是文章没有效果,需要等官方发版,具体发版时间未知(我是中午可以在线上编辑器看到,晚上就能使用了)。
  9. 不能有外链,也不能使用特殊字体,背景图片必须是base64格式的。
  10. 提交PR的时候合并成单条commit记录,不建议连历史一起提交,我是第一次不懂,一直在修改,可以在同一个commit下提交。
  11. 还有一些想到再补充😊


总体还是挺简单的,希望大家多多贡献,也能让我有更多选择。

我是Mancuoj,如果还有什么疑问或者踩了什么坑可以评论留言,我都会回复的,求个赞👍

目录
相关文章
|
JSON 数据可视化 图形学
Graphix: 轻量级、可插拔、OOP 式图形编辑器开发引擎
A lightweight, pluggable, object-oriented programming (OOP) style graphic editor development engine / 一个轻量级、可插拔、OOP 式图形编辑器开发引擎
275 2
|
存储 搜索推荐 Shell
【Shell 命令集合 文本编辑器】Linux joe 编辑器的使用教程
【Shell 命令集合 文本编辑器】Linux joe 编辑器的使用教程
187 0
|
存储 安全 数据挖掘
【工具】HxD Hex Editor 的安装、使用详细教程
【工具】HxD Hex Editor 的安装、使用详细教程
2890 0
|
10月前
Axure设计之文本编辑器制作教程
本文介绍如何在Axure中模拟Web端富文本编辑器,实现基本的文本编辑功能,包括自定义字体样式、大小、颜色及对齐方式等。通过拖入矩形、文本域等元件,添加单选框和图标,并设置相应的交互,完成文本编辑器的制作。
328 2
|
存储 安全 数据安全/隐私保护
Django 后端架构开发:富文本编辑器权限管理与 UEditor 、Wiki接入,实现 Markdown 文本编辑器
Django 后端架构开发:富文本编辑器权限管理与 UEditor 、Wiki接入,实现 Markdown 文本编辑器
551 0
|
存储 移动开发 编解码
基于HTML5开发的Markdown在线编辑器
Markdown是一种轻量级标记语言,以其简洁易读的格式而备受程序员和作者们的青睐。随着互联网的发展,越来越多的在线Markdown编辑器应运而生,为用户提供了更加便捷、高效的写作和编辑环境。本文将探讨基于HTML5开发的Markdown在线编辑器的设计原理、功能特点以及技术优势。
322 4
|
移动开发 前端开发 JavaScript
基于 HTML5 和 Canvas 开发的在线图片编辑器
基于 HTML5 和 Canvas 开发的在线图片编辑器
336 0
|
10月前
|
前端开发
业余时间开发了个海报编辑器
为了满足撰写博客或录制教程视频时对高质量海报的需求,我利用业余时间开发了一款海报编辑器。第一版功能简单,支持固定尺寸、黑底白字的标题。后来经过优化,增加了背景图、模糊效果、文字样式调整等功能,使海报更具吸引力。目前该编辑器已上线,欢迎大家试用并反馈。[访问海报编辑器](https://tool.share888.top/#/poster)
171 6
业余时间开发了个海报编辑器
|
11月前
|
运维 Java Linux
【运维基础知识】掌握VI编辑器:提升你的Java开发效率
本文详细介绍了VI编辑器的常用命令,包括模式切换、文本编辑、搜索替换及退出操作,帮助Java开发者提高在Linux环境下的编码效率。掌握这些命令,将使你在开发过程中更加得心应手。
137 2
|
图形学 开发者 存储
超越基础教程:深度拆解Unity地形编辑器的每一个隐藏角落,让你的游戏世界既浩瀚无垠又细节满满——从新手到高手的全面技巧升级秘籍
【8月更文挑战第31天】Unity地形编辑器是游戏开发中的重要工具,可快速创建复杂多变的游戏环境。本文通过比较不同地形编辑技术,详细介绍如何利用其功能构建广阔且精细的游戏世界,并提供具体示例代码,展示从基础地形绘制到植被与纹理添加的全过程。通过学习这些技巧,开发者能显著提升游戏画面质量和玩家体验。
788 3

热门文章

最新文章