螺旋马克下至 JCR
一个将马克下调转换为JCR的库.
状态
发展
通过运行安装所有依赖 :
npm install
使用量
安装
您可以通过 npm 安装软件包 :
npm install @adobe/helix-md2jcr
或直接使用它与 npx 不安装 :
npx @adobe/helix-md2jcr path/to/content.md
将 Markdown 转换为 JCR 节点
软件包包括一个 CLI 工具 md2jcr 将标记下的文件转换为 JCR XML 格式.
基本用途:
npx @adobe/helix-md2jcr path/to/content.md
转换单个文件 :
md2jcr test/fixtures/simple.md
转换目录中所有标记下的文件 :
md2jcr test/fixtures/
用动词旗查看控制台中的输出 -v数字 :
md2jcr test/fixtures/simple.md -v
查看已解码的 XML 输出 -v 财务报告和审定财务报表 -d 旗帜 :
md2jcr test/fixtures/simple.md -v -d
使用目录中的自定义通用编辑器文件 :
md2jcr content.md -ue path/to/ue-files-directory
转换器将生成一个 .xml 与包含 JCR 结构的标记下文件并列的文件。 这可用于检查由于转换而可能出现的内容变化.
命令行选项
-v, (中文(简体) ),--verbose- 将 XML 输出打印到控制台-d, (中文(简体) ),--decode- XML 输出中的解码 HTML 实体(使用-v(中文(简体) )-ue, (中文(简体) ),--ue-files <directory>- 指定包含通用编辑器配置文件的目录
示例目录结构 :
ue-files/
├── component-models.json
├── component-definition.json
└── component-filters.json
程序用途
您也可以在节点代码中程序化地使用库:
import { md2jcr } from '@adobe/helix-md2jcr';
const markdown = '# Hello World\n\nThis is a test.';
const options = {
models: [...],
definition: {...},
filters: [...]
};
const xml = await md2jcr(markdown, options);
console.log(xml);
文档
- 集装箱区块 ——容器块映射母体的方式 属性和子项(一栏/多栏规则,省略父项) 行,以及出错的情况)。 另见 集装箱区块试验装置 以工作情景为例.
- 块选项( 分类) 区块选项类和
元素分组( e)
classes, (中文(简体) ),classes_*: 如何将页眉选项路由到 字段的选项或布尔后缀. - 区域样式 - 一节的元素分组
style组style, (中文(简体) ),style_*: 单节元数据如何style单元格将返回字段,镜像块选项. - 实地提示 - 使用
<!-- field: name -->跳过 在战地小组内. - 定义内容 — 支持的内置 HTML 标记(
sup, (中文(简体) ),sub, (中文(简体) ),u, (中文(简体) ),del, (中文(简体) ),strong, (中文(简体) ),em以及他们如何活过减速 ~ JCR管道.
基线 XML 文件
运行./ Baseline-tests.sh脚本将在测试/固定下检测出任何md文件并执行转换2jcr节点脚本.
脚本将在它定位的 md 文件旁边生成新的 xml 文件 。 对转换器进行修改时会有帮助
您想要查看这些变化是否对输出有任何影响。 通过使用 git diff,您可以看到 xml 文件的新变化 .
如果您对修改感到满意,您可以提交新的 xml 文件.
运行测试
只需执行以下命令即可运行测试 :
npm test