标记下变换 API

高级API在由此单列所支持的各种格式(CommonMark, CiceroMark, TemplateMark, HTML, Plaintext, CiceroEdit等)之间转换标记下的内容.

安装

npm install @accordproject/markdown-transform

此软件包取决于 markdown-common, (中文(简体) ), markdown-cicero, (中文(简体) ), markdown-template 财务报告和审定财务报表 markdown-html,自动拉入.

基本用途

import { transform } from '@accordproject/markdown-transform';

// markdown → HTML
const html = await transform(markdown, 'markdown', ['html']);

第三个参数是一系列目的格式。 当给予不止一个时,变相会被连锁地穿过每一个.

// markdown → ciceromark (unquoted variables) → HTML
const html = await transform(markdown, 'markdown', ['ciceromark_unquoted', 'html']);

在共同JS中:

const { transform } = require('@accordproject/markdown-transform');

支持的格式

markdown, (中文(简体) ), markdown_cicero, (中文(简体) ), markdown_template, (中文(简体) ), commonmark_tokens, (中文(简体) ), ciceromark_tokens, (中文(简体) ), templatemark_tokens, (中文(简体) ), commonmark, (中文(简体) ), ciceromark, (中文(简体) ), ciceromark_parsed, (中文(简体) ), ciceromark_unquoted, (中文(简体) ), templatemark, (中文(简体) ), ciceroedit, (中文(简体) ), html, (中文(简体) ), plaintext。 。 。 .

使用 formatDescriptor(name) 检查格式 fileFormat (单位:千美元)utf8 编号 : json 编号 : binary及其外缘,或 new TransformEngine(builtinTransformationGraph) 来注册自己的格式/转换.

变形图

您可以为所支持的转换生成 PlantUML 状态图 :

import { generateTransformationDiagram } from '@accordproject/markdown-transform';
const plantUml = generateTransformationDiagram();

许可证

Accord Project源代码文件在位于LICENSE文件的Apache许可证2.0版本(Apache-2.0)下提供. 项目文件文件根据创用CC-BY-4.0国际许可证提供 http://creativecommons.org/licenses/by/ 4.0/ 页面存档备份,存于互联网档案馆。 。 。 .