Remark

配置参数

extensions string[]

List of extensions this plugin applies to

Default:

[ ".md" ]

remarkPlugins object

List of remark plugins to use

Default:

[remarkGfm]

rehypeOptions object

Options to pass to rehype

Default:

{ allowDangerousHtml: true }

rehypePlugins object

List of rehype plugins to use

sanitize boolean

Flag to turn on HTML sanitization to prevent XSS

Default:

false

useDefaultPlugins boolean

Set false to remove the default plugins

Default:

true

描述

此插件使用 Remark 渲染 markdown 文件，替换默认的 markdown-it 库。它允许使用 Remark 和 Rehype 插件。默认情况下，它使用 GitHub Flavored Markdown。

安装

在你的 _config.ts 文件中导入此插件以使用它：

import lume from "lume/mod.ts";
import remark from "lume/plugins/remark.ts";

const site = lume();

site.use(remark());

export default site;

插件

使用 remarkPlugins 和 rehypePlugins 配置额外的插件：

import lume from "lume/mod.ts";
import remark from "lume/plugins/remark.ts";
import a11yEmoji from "npm:@fec/remark-a11y-emoji";
import rehypeRemoveComments from "npm:rehype-remove-comments@5";

const site = lume();

site.use(remark({
  remarkPlugins: [a11yEmoji],
  rehypePlugins: [[rehypeRemoveComments, { removeConditional: true }]],
}));

export default site;