README
README
参考资料
开发无关,仅使用
- 通用资料
- Github开源地址
- Github文档
- 【Github.io】Markdown-it API 文档
- 中文文档
- 主页文档:https://markdown-it.docschina.org/
- 在主页上方还有其他页:构造、开发者建议、安全、DocsChina主页、【Github】markdown-it
- 使用资料
- 中文文档:https://markdown-it.docschina.org/
插件开发者资料
- 官方资料
- /markdown-it/docs/,Github插件开发文档
- examples/
- renderer_rules.md,渲染规则
- architecture.md,解析器架构和设计原则,好用
- development.md,插件开发者的一些指南,好用
- security.md,安全 相关
- 4.0_migration.md,迁移到v4
- 5.0_migration.md,迁移到v5
- examples/
- 【Github.io】Markdown-it 官方演示及调试页面
- 使用说明:该演示页面的右侧标签栏有 html、source、debug 三个选项,分别是 html展示、html源码、TokensStream结构。
能看TokensStream好用的,这能很方便地帮助我们开发。
- 使用说明:该演示页面的右侧标签栏有 html、source、debug 三个选项,分别是 html展示、html源码、TokensStream结构。
- 英文文档:https://markdown-it.github.io/markdown-it/(英文API,好用)
- 核心源码,那个lib文件夹下的都是
- /markdown-it/docs/,Github插件开发文档
- 第三方资料
- 《markdown-it 中文文档》,(中文API,这个也很好用)
【知乎】markdown-it 原理解析- 【简书】markdown-it解析
《博客搭建》冴羽
- 作者主页
- GitHub - 作者主页,InfoQ - 作者主页
- 最终效果网站:冴羽的 JavaScript 博客
- 备用链接:例如 InfoQ - markdown-it 插件如何写(一) 或 markdown-it 插件如何写(一) 或 markdown-it 插件如何写(一),这几个的内容是一样的,只是作者在不同的平台发布而已
- 其中,和markdown-it关联的部分:
- 个人吐槽
- 话说他这个Github文章居然是写在issue里的,神奇……也许是为了方便使用评论功能吧
- 注意,有一些文章内部链接跳转到 markdown-it Github 源码并出现404的,需要将末尾的 .js 替换成 .mjs
优秀的mdit插件
这里主要列举开源的,以便可以去参考源码和学习
一些框架的默认插件
VitePress 默认插件
VuePress 默认插件
Vue 相关mdit插件
- 插件列表
- markdown-it
- markdown-it-emoji
- markdown-it-sub
- markdown-it-sup
- markdown-it-footnote
- markdown-it-deflist
- markdown-it-abbr
- markdown-it-ins
- markdown-it-mark
- markdown-it-katex
- markdown-it-task-lists
- markdown-it-highlight
- markdown-it-latex
- markdown-it-container
- markdown-it-github-toc
- markdown-it-source-map
- markdown-it-link-attributes
- 内部插件列表
- markdown-it-image
- markdown-it-font-awsome
- markdown-it-link-attributes
- markdown-it-highlight
- markdown-it-plugin-echarts
- markdown-it-plugin-mermaid
- markdown-it-plugin-flowchart
VuePress-Theme-Hope 默认插件
Github高Star插件
- Github比较高Star的几个:(有专门的主题,可以在 https://github.com/topics/markdown-it-plugin 里看)
- https://github.com/desenmeng/markdown-it-plugin,“a markdown-it plugin demo”,足够简单,只有一个js文件
- https://github.com/geekplux/markvis,1.6k,围栏代码块vis触发,显示柱形图/波形图
- markdown-it/markdown-it-emoji, 表情符号语法插件markdown-it markdown解析器
- waylonflinn/markdown-it-katex, 添加数学到您的Markdown与KaTeX插件Markdown-it
- markdown-it/markdown-it-container, markdown-it markdown解析器的隔离容器插件
- executablebooks/markdown-it-py, Markdown解析器,做得对。100% CommonMark支持,扩展,语法插件和高速。现在在Python中!
- valeriangalliat/markdown-it-anchor, 一个markdown-it插件,为标题和可选的永久链接添加' id '属性。
- markdown-it-collapsible,用
+++
标记代替 HTML<details>
and<summary>
来设置可折叠区域 - markdown-it-color,内联颜色
- markdown-it-markmap,脑图
- (个人研究推荐)
- markdown-it-multimd-table, 扩展表格
- markdown-it-link-to-card,将链接转换为卡片
- markdown-it-obsidian-callouts,Obsidian的callout语法
其他
- Npmjs比较高分的几个:
- 略,npm自己搜
- 其他
- adam-p/markdown-here, 谷歌Chrome, Firefox和雷鸟扩展,让您在Markdown中编写电子邮件并在发送前渲染它。
- hexojs/hexo-renderer-markdown-it, Markdown-这是一个Markdown解析器,操作正确。一个更快和CommonMark兼容替代Hexo。
优秀的mdit插件 (旧)
可参考
table-extended
Obsidian插件:aidenlx/table-extended
里面提到:
由于当前黑曜石 API 的限制,内置的 markdown解析器 不可配置。相反,这个插件包括一个独立的 Markdown 解析器 markdown-it 和插件 markdown-it-multimd-table,表格部分和带有语言标签
tx
的代码块内的文本被传递给markdown-it
。然而,内部链接和嵌入被提取并传递给黑曜石,因此黑曜石的核心特征保持不变。
请注意,该插件的行为可能与官方的 MultiMarkdown 编译器和黑曜石的解析器不同,如果合理的输入出现意外结果,请提出问题。
不符合需求
keep-it-markdown
使用非官方的Keep API将 Google Keep笔记动态转换为 黑曜石,Logseq,Joplin和Concept的markdown。此外,将简单的markdown笔记导入回Google Keep。
markdown-it-obsidian-plus
Markdown-it插件:klequis/markdown-it-obsidian-plus
markdown-it插件将 obsidian markdown 转换为HTML
不过似乎和 Obsidian 没有什么关系
markdown-it-obsidian
将 Obsidian 的 wiki 链接转化为 markdown链接
链接到当前文件 0
没有文件链接到当前文件