跳到正文

开始使用 Markdoc

请按照以下说明在您的应用中安装 Markdoc。或者查看我们的集成指南以帮助您构建文档站点。

安装 Markdoc

安装 Markdoc 库：

npm install @markdoc/markdoc

或

yarn add @markdoc/markdoc

导入 Markdoc

在您的应用中导入 Markdoc 库：

const Markdoc = require('@markdoc/markdoc');

如果使用 ESM：

import Markdoc from '@markdoc/markdoc';

使用 Markdoc

调用 parse、transform 和 render Markdoc 函数来渲染您的内容。

const source = '# Markdoc';

const ast = Markdoc.parse(source);
const content = Markdoc.transform(ast, /* [配置](/docs/config) */);

const html = Markdoc.renderers.html(content);

后续步骤