普通马克变形器

将下标文本转换为/ 从 CommonMark DOM 中转换 .

CommunityMark DOM 是一个音乐会模式——参见 [email protected]。 。 。 .

安装

npm install @accordproject/markdown-common

同伴依赖 : @accordproject/concerto-core@^5.0.0。 。 。 .

使用量

import { CommonMarkTransformer } from '@accordproject/markdown-common';

const transformer = new CommonMarkTransformer();
const dom = transformer.fromMarkdown('# Heading\n\nThis is some `code`.\n\nFin.');
console.log(JSON.stringify(dom, null, 4));

通用JS同样工作:

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

产出是:

{
    "$class": "[email protected]",
    "xmlns": "http://commonmark.org/xml/1.0",
    "nodes": [
        {
            "$class": "[email protected]",
            "level": "1",
            "nodes": [
                {
                    "$class": "[email protected]",
                    "text": "Heading"
                }
            ]
        },
        {
            "$class": "[email protected]",
            "nodes": [
                {
                    "$class": "[email protected]",
                    "text": "This is some "
                },
                {
                    "$class": "[email protected]",
                    "text": "code"
                },
                {
                    "$class": "[email protected]",
                    "text": "."
                }
            ]
        },
        {
            "$class": "[email protected]",
            "nodes": [
                {
                    "$class": "[email protected]",
                    "text": "Fin."
                }
            ]
        }
    ]
}

您可以操纵 DOM 并将其转换回下调 :

dom.nodes[0].nodes[0].text = 'My New Heading';
const newMarkdown = transformer.toMarkdown(dom);
console.log(newMarkdown);

新的标记下字符串将是:

My New Heading
====

This is some `code`.

Fin.

注意 H1 标题在从 # 语法改为 ==== 语法. 在CommonMark中,这些是等同的.

此套件导出什么

• CommonMarkTransformer - 减分 普通马克DOM
• ToMarkdownVisitor, (中文(简体) ), FromCommonMarkVisitor, (中文(简体) ), FromMarkdownIt ——下层构件
• CommonMarkUtils – 用于渲染标记下调的助手( 取消缩写, 列表前缀等)
• Stack 参观者使用的通用堆栈
• CommonMarkModel, (中文(简体) ), CiceroMarkModel, (中文(简体) ), ConcertoMetaModel, (中文(简体) ), TemplateMarkModel – 音乐会命名空间/ MODEL 字符串被此单曲中其他软件包所消耗

许可证

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