Markdoc支付公司 Stripe 开发的创作框架

Markdoc 是一个基于 Markdown 的语法和工具链，用于创建自定义文档网站，具有功能强大、使用灵活和可扩展的特点。Markdoc 由支付公司 Stripe 开发，最初用于支持 Stripe 的公共文档，这是他们最大和最复杂的内容网站。

安装

要开始使用 Markdoc，首先使用以下命令安装库：

npm install @markdoc/markdoc 

或者是

yarn add @markdoc/markdoc

并将其导入你的应用程序：

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

或者如果你使用的是 ESM

import Markdoc from '@markdoc/markdoc';

然后使用在你的应用或工具中使用Markdoc：

const doc = `

# Markdoc README



{% image src="/logo.svg" /%}

`;



const ast = Markdoc.parse(doc);

const content = Markdoc.transform(ast);

return Markdoc.renderers.react(content, React);

开发

1. 运行 npm install


2. 运行 npm run build


3. 使用npm test运行测试