Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@accordproject/markdown-common
Advanced tools
Readme
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.Document",
"xmlns": "http://commonmark.org/xml/1.0",
"nodes": [
{
"$class": "org.accordproject.commonmark.Heading",
"level": "1",
"nodes": [
{
"$class": "org.accordproject.commonmark.Text",
"text": "Heading"
}
]
},
{
"$class": "org.accordproject.commonmark.Paragraph",
"nodes": [
{
"$class": "org.accordproject.commonmark.Text",
"text": "This is some "
},
{
"$class": "org.accordproject.commonmark.Code",
"text": "code"
},
{
"$class": "org.accordproject.commonmark.Text",
"text": "."
}
]
},
{
"$class": "org.accordproject.commonmark.Paragraph",
"nodes": [
{
"$class": "org.accordproject.commonmark.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 372 weekly downloads. As such, @accordproject/markdown-common popularity was classified as not 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
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.