@readme /减价
ReadMe的风味Markdown解析器和MDX渲染引擎。
npm install --save @readme/markdown
使用
默认情况下,更新后的markdown包导出一个函数,该函数接受字符串 ReadMe-flavored减价 并返回一个React组件树:
import React from 'react';
import rdmd from "@readme/markdown";
export default ({ body }) => (
<div className="markdown-body">
{rdmd(body)}
</div>
);
出口的方法
除了默认的React处理器,该包还导出了一些其他的方法来转换readme风格的markdown:
| 出口 | 描述 | 参数 |
|---|---|---|
react | (默认) 返回一个VDOM树对象 | text, options |
md | 将mast转换为readme风格的markdown | tree, options |
html | 将标记转换为HTML | text, options |
mdast | 将标记转换为目标对象 | text, options |
hast | 将标记转换为HAST对象 | text, options |
plain | 将标记转换为纯文本 | text, options |
utils | 上下文、默认值、帮助程序等。 | N/A |
设置和选项
每个处理器方法都有一个options对象,你可以用它来调整输出的HTML或React树。这些选项包括:
compatibilityMode——允许 兼容性特性 从我们旧的降价引擎。copyButtons-自动插入一个按钮复制文本块到剪贴板。目前使用于<code>元素。correctnewlines-将新的行分隔符呈现为<br>标签。markdownOptions——备注 解析器选项.safeMode-渲染html块为<pre>元素。我们通常允许所有可能执行JavaScript的html属性。
味的语法
我们的旧编辑器从自定义的、基于json的语法呈现“Magic Block”组件。为了提供无缝的向后兼容性,我们的新处理器内置了对解析这种旧格式的支持,并将其直接转换为我们新的、经过调味的Markdown。
我们还在上面撒了一点我们自己的语法糖,让您可以对文档进行增压。 了解有关ReadMe风味语法的更多信息!
地方发展
要在本地更改rmd引擎,请运行本地开发服务器。克隆回购, cd 在它里面, npm install, npm run start!
环境设置
运行浏览器测试需要 docker. 跟着码头走 MAC安装说明。你可能想要增加 内存使用情况. 如果你还没有,你需要创建一个帐户 docker hub 和 本地登录.
运行视觉回归测试
如果更改了文档或更改了markdown的呈现方式,则可能需要更新可视化回归快照。你可以在docker容器中运行可视化回归测试:
make updateSnapshot