![NIST Misses 2024 Deadline to Clear NVD Backlog](https://cdn.sanity.io/images/cgdhsj6q/production/8435754fe16c9e8b9d590302937729fe968fffe0-600x527.png?w=400&fit=max&auto=format)
Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
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.
remark-stringify
Advanced tools
The remark-stringify package is a plugin for the remark ecosystem that allows you to serialize Markdown Abstract Syntax Trees (ASTs) into Markdown text. It is commonly used in conjunction with other remark plugins to process and transform Markdown content programmatically.
Basic Markdown Serialization
This feature allows you to convert a Markdown AST into a Markdown string. The example demonstrates how to serialize a simple AST representing a paragraph with the text 'Hello, world!'.
const remark = require('remark');
const stringify = require('remark-stringify');
const markdownAST = {
type: 'root',
children: [
{ type: 'paragraph', children: [{ type: 'text', value: 'Hello, world!' }] }
]
};
const markdownText = remark().use(stringify).stringify(markdownAST);
console.log(markdownText); // Outputs: 'Hello, world!\n'
Customizing Output
This feature allows you to customize the output format of the serialized Markdown. The example shows how to set options for bullet points and fenced code blocks.
const remark = require('remark');
const stringify = require('remark-stringify');
const markdownAST = {
type: 'root',
children: [
{ type: 'paragraph', children: [{ type: 'text', value: 'Hello, world!' }] }
]
};
const markdownText = remark()
.use(stringify, { bullet: '*', fences: true })
.stringify(markdownAST);
console.log(markdownText); // Outputs: 'Hello, world!\n'
Handling Complex ASTs
This feature demonstrates how to handle more complex ASTs, including headings, paragraphs, and lists. The example shows how to serialize an AST with multiple types of nodes.
const remark = require('remark');
const stringify = require('remark-stringify');
const markdownAST = {
type: 'root',
children: [
{ type: 'heading', depth: 1, children: [{ type: 'text', value: 'Title' }] },
{ type: 'paragraph', children: [{ type: 'text', value: 'This is a paragraph.' }] },
{ type: 'list', ordered: false, children: [
{ type: 'listItem', children: [{ type: 'paragraph', children: [{ type: 'text', value: 'Item 1' }] }] },
{ type: 'listItem', children: [{ type: 'paragraph', children: [{ type: 'text', value: 'Item 2' }] }] }
] }
]
};
const markdownText = remark().use(stringify).stringify(markdownAST);
console.log(markdownText); // Outputs: '# Title\n\nThis is a paragraph.\n\n* Item 1\n* Item 2\n'
Markdown-it is a fast and flexible Markdown parser that can also be used to render Markdown from an AST. It offers a wide range of plugins and customization options, making it a versatile alternative to remark-stringify.
Marked is a low-level Markdown compiler that allows for extensive customization. It is known for its speed and flexibility, making it a good choice for projects that require fine-grained control over Markdown rendering.
Showdown is a bidirectional Markdown to HTML converter that can also be used to serialize Markdown from an AST. It is easy to use and offers a range of extensions for additional functionality.
Compiler for unified. Stringifies an MDAST syntax tree to markdown. Used in the remark processor. Can be extended to change how markdown is compiled.
npm:
npm install remark-stringify
var unified = require('unified');
var createStream = require('unified-stream');
var parse = require('remark-parse');
var toc = require('remark-toc');
var stringify = require('remark-stringify');
var processor = unified()
.use(parse)
.use(toc)
.use(stringify, {
bullet: '*',
fence: '~',
fences: true,
incrementListMarker: false
});
process.stdin
.pipe(createStream(processor))
.pipe(process.stdout);
processor.use(stringify)
Configure the processor
to stringify MDAST syntax trees
to markdown.
options
Options are passed later through processor.stringify()
,
processor.process()
, or processor.pipe()
.
The following settings are supported:
gfm
(boolean
, default: true
):
|
, for tables):
, for literal URLs)~
, for strike-through)commonmark
(boolean
, default: false
):
pedantic
(boolean
, default: false
):
entities
(string
or boolean
, default: false
):
true
— Entities are generated for special HTML characters
(&
> &
) and non-ASCII characters (©
> ©
).
If named entities are not (widely) supported, numbered character
references are used (’
> ’
)
'numbers'
— Numbered entities are generated (&
> &
)
for special HTML characters and non-ASCII characters
'escape'
— Special HTML characters are encoded (&
>
&
, ’
> ’
), non-ASCII characters not (ö persists)
setext
(boolean
, default: false
)
— Compile headings, when possible, in Setext-style: using =
for
level one headings and -
for level two headings. Other heading
levels are compiled as ATX (respecting closeAtx
)
closeAtx
(boolean
, default: false
)
— Compile ATX headings with the same amount of closing hashes as
opening hashes
looseTable
(boolean
, default: false
)
— Create tables without fences (initial and final pipes)
spacedTable
(boolean
, default: true
)
— Create tables without spacing between pipes and content
paddedTable
(boolean
, default: true
)
— Create tables with padding in each cell so that they are the same size
fence
('~'
or '`'
, default: '`'
)
— Fence marker to use for code blocks
fences
(boolean
, default: false
)
— Stringify code blocks without language with fences
bullet
('-'
, '*'
, or '+'
, default: '-'
)
— Bullet marker to use for unordered list items
listItemIndent
('tab'
, 'mixed'
or '1'
, default: 'tab'
)
How to indent the content from list items:
'tab'
: use tab stops (4 spaces)'1'
: use one space'mixed'
: use 1
for tight and tab
for loose list itemsincrementListMarker
(boolean
, default: true
)
— Whether to increment ordered list item bullets
rule
('-'
, '*'
, or '_'
, default: '*'
)
— Marker to use for thematic breaks (horizontal rules)
ruleRepetition
(number
, default: 3
)
— Number of markers to use for thematic breaks (horizontal rules).
Should be 3
or more
ruleSpaces
(boolean
, default true
)
— Whether to pad thematic break (horizontal rule) markers with
spaces
strong
('_'
or '*'
, default '*'
)
— Marker to use for importance
emphasis
('_'
or '*'
, default '_'
)
— Marker to use for emphasis
stringify.Compiler
Access to the raw compiler, if you need it.
If this plug-in is used, it adds a Compiler
constructor
to the processor
. Other plug-ins can change and add visitors on
the compiler’s prototype to change how markdown is stringified.
The below plug-in modifies a visitor to add an extra blank line before level two headings.
module.exports = gap;
function gap() {
var Compiler = this.Compiler;
var visitors = Compiler.prototype.visitors;
var heading = visitors.heading;
visitors.heading = heading;
function heading(node) {
return (node.depth === 2 ? '\n' : '') + heading.apply(this, arguments);
}
}
Compiler#visitors
An object mapping node types to visitor
s.
function visitor(node[, parent])
Stringify node
.
string
, the compiled given node
.
FAQs
remark plugin to add support for serializing markdown
The npm package remark-stringify receives a total of 3,143,789 weekly downloads. As such, remark-stringify popularity was classified as popular.
We found that remark-stringify demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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
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.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.