npm 包 cbml 使用教程

阅读时长 3 分钟读完

简介

cbml 是一个通用的文本标记解析器,能够将标记语言转换成 HTML 或其他格式。它采用了类似于 Markdown 的语法,同时支持自定义标签和样式。

安装

在 npm 中安装 cbml:

使用

使用 cbml 很简单,只需要将文本传递到 cbml 函数中即可:

-- -------------------- ---- -------
----- ---- - ----------------

----- ---- - -
- ---

-------

- ----
- ----

----------

-------------------
--

----- ---- - -----------
------------------

输出结果:

语法

标题

cbml 支持六个不同级别的标题,分别用一到六个 # 开头表示:

段落

cbml 中连续多行文本会被解析成一个段落。

列表

cbml 支持有序列表和无序列表,有序列表用数字和 . 或者 ) 表示,无序列表用 * 或 + 或 - 表示。

链接

可以使用 text 语法创建链接。链接也可以有可选的标题:

图片

图片和链接类似,但是在前面需要加一个 !:

引用

可以使用 > 表示引用:

代码块

可以使用 ``` 或者 ~~~ 表示代码块,可以在前面加上语言名字,以便语法高亮:

自定义标签

cbml 允许自定义标签,语法格式为

样式

可用 {{css-styles}} 定义样式,如

规则顺序

cbml 解析器的规则顺序如下:

  1. 自定义标签
  2. 标题
  3. 列表
  4. 图片
  5. 链接
  6. 引用
  7. 代码块
  8. 段落

总结

cbml 是一个非常强大的文本标记解析器,除了标准的 Markdown 语法外,还支持自定义标签和样式。如果你正在开发一个需求类似的项目,不妨试试 cbml,相信它会给你带来意想不到的惊喜!

示例代码

本文示例代码已经包含在上述内容中,如果需要复制和粘贴,可以查看全文的 Markdown 版本 来获取。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/72334

纠错
反馈