Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@accordproject/markdown-common
Advanced tools
Converts markdown text to/from a DOM.
To transform markdown text, first install the markdown-common
package:
npm install @accordproject/markdown-common --save
Then in your JavaScript code:
const CommonMarkTransformer = require('@accordproject/markdown-common').CommonMarkTransformer;
const transformer = new CommonMarkTransformer({ tagInfo : true });
const json = transformer.fromMarkdown('# Heading\n\nThis is some `code`.\n\nFin.', 'json');
console.log(JSON.stringify(json, null, 4));
The output should be:
{
"$class": "org.accordproject.commonmark@0.5.0.Document",
"xmlns": "http://commonmark.org/xml/1.0",
"nodes": [
{
"$class": "org.accordproject.commonmark@0.5.0.Heading",
"level": "1",
"nodes": [
{
"$class": "org.accordproject.commonmark@0.5.0.Text",
"text": "Heading"
}
]
},
{
"$class": "org.accordproject.commonmark@0.5.0.Paragraph",
"nodes": [
{
"$class": "org.accordproject.commonmark@0.5.0.Text",
"text": "This is some "
},
{
"$class": "org.accordproject.commonmark@0.5.0.Code",
"text": "code"
},
{
"$class": "org.accordproject.commonmark@0.5.0.Text",
"text": "."
}
]
},
{
"$class": "org.accordproject.commonmark@0.5.0.Paragraph",
"nodes": [
{
"$class": "org.accordproject.commonmark@0.5.0.Text",
"text": "Fin."
}
]
}
]
}
Please refer to the schema for the details of all the the nodes that you should expect in the DOM.
You can then manipulate the DOM object, making any required changes:
json.nodes[0].nodes[0].text = 'My New Heading';
Finally converting the DOM back into a markdown string:
const newMarkdown = commonMark.toMarkdown(json);
console.log(newMarkdown);
The new markdown string will be:
My New Heading
====
This is some `code`.
Fin.
Note how the original H1 heading has been normalized during conversion from
#
syntax to====
syntax. In commonmark these are equivalent.
Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.
© 2017-2019 Clause, Inc.
FAQs
A framework for transforming markdown
The npm package @accordproject/markdown-common receives a total of 1,663 weekly downloads. As such, @accordproject/markdown-common popularity was classified as popular.
We found that @accordproject/markdown-common demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.