简介
remark-preset-wooorm 是一个强大的 Markdown 处理工具,它基于 remark 和 rehype,提供了一系列方便的插件,可以帮助你更加简单地处理 Markdown 文本。
安装
使用 npm 安装 remark-preset-wooorm:
npm install remark-preset-wooorm
使用
基本使用
在 Node.js 中,我们可以通过以下方式使用 remark 和 rehype 处理 Markdown:
-- -------------------- ---- ------- ----- ------- - ------------------ ----- -------- - ----------------------- ----- ------------- - ------------------------ ----- ---- - --------------------------- ----- --------- - --------- -------------- ------------------- ---------- ----- ----- - -- ------ ------- ----- ------ - --------------------------------------- ------------------- -- ---------- -----------
如果使用 remark-preset-wooorm,则需要将 .use(markdown)
改为 .use(require('remark-preset-wooorm'))
:
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------------ - ------------------------------- ----- ------------- - ------------------------ ----- ---- - --------------------------- ----- --------- - --------- ------------------ ------------------- ---------- ----- ----- - -- ------ ------- ----- ------ - --------------------------------------- ------------------- -- ---------- -----------
插件列表
remark-preset-wooorm 包含了以下插件:
- remark-parse
- remark-gfm
- remark-footnotes
- remark-slug
- remark-autolink-headings
- remark-emoji
- remark-smartypants
- rehype-stringify
你可以根据自己的需要选择使用。如果你想要关闭某个插件,可以通过以下方式进行配置:
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------------ - ------------------------------- ----- ------------- - ------------------------ ----- ---- - --------------------------- ----- --------- - --------- ------------------ - ---------- ------ ------ ------ -- ------------------- ---------- ----- ----- - -- ------ ------- ----- ------ - --------------------------------------- ------------------- -- ---------- -----------
自定义配置
如果 remark-preset-wooorm 默认提供的插件无法满足你的需求,你可以通过 .remarkConfig()
方法自定义配置。例如,下面的代码展示了如何在 Markdown 中支持 LaTeX 公式:
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------------ - ------------------------------- ----- ------------- - ------------------------ ----- ----- - ----------------------- ----- ---- - --------------------------- ----- --------- - --------- ------------------ ------------------- - ------------------- ---- -- ----------- ---------- ----- ----- - ---- ------- -------- -- ------------ ----- ------ - --------------------------------------- ------------------- -- ------ ------- ----- ------------------- ------------- -------------------------------------- ------------------------ ------------------------ ------------------ ----------- --------------------- --------------------- -------------------------- --------------------- ------------- ------------------------- ------------------------------------------ ------------------------- -------------------------- ------------------- ----------------------------------- -------------- ------------------------------------ ----------- ---------------------------- ------------------------- -------------------------- ------------ - ----------------------------------------------------------- -------- ----------------------------------------------------------------------------------