简介
在编写 Markdown 文档时,经常需要为标题添加锚点,以便于跳转到文档的不同部分。remark-slug 是一个用于生成唯一和易于阅读的 slug 的 remark 插件。slug 可以作为 HTML 中的 id 属性使用,并且可以通过链接直接访问到该节内容。
本篇文章将详细介绍如何使用 remark-slug 插件来生成 slug,并给出代码示例。
安装
可以通过以下命令安装 remark-slug:
--- ------- -----------
使用
在 markdown 文件中,添加 remark-slug 插件即可。下面是一个简单的例子:
- ----- ----- ---- -- -- -------- -- ------------ -- ------- ---- -------- ----
npm install my-package
渲染后,会生成类似下面这样的 HTML 代码:
--- ---------------------- ---------- ------- -- -- ------------ --- ----------------------------------- ----- ------- ---- -------- -------- ---------- ----------------------- ------- ---------- -------------
可以看到,<h1>
和 <h2>
标题都被自动添加上了 id
属性,值为其对应的 slug。
配置
remark-slug 插件支持以下配置选项:
prefix
: slug 的前缀,默认为空字符串。suffix
: slug 的后缀,默认为空字符串。maintainCase
: 是否保留原标题的大小写,默认为false
,即转换为小写字母。
可以通过以下代码进行配置:
----- ------ - ----------------- ----- ---------- - ---------------------- -------- ---------------- - ------- ----------- ------- --- ------------- ---- -- ------------------------ ----- ------- -- - --------------------------- --
总结
remark-slug 插件是一个非常实用的插件,能够方便地生成唯一和易于阅读的 slug。在使用 remark 编写文档时,可以考虑使用该插件来改善阅读体验。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/41812