Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
remark-custom-blocks
Advanced tools
Readme
This plugin parses custom Markdown syntax to create new custom blocks. It adds new nodes types to the mdast produced by remark:
{yourType}CustomBlock
If you are using rehype, the stringified HTML result will be div
s with configurable CSS classes.
It is up to you to have CSS rules producing the desired result for these classes.
The goal is to let you create blocks or panels somewhat similar to these.
Each custom block can specify CSS classes and whether users are allowed or required to add a custom title to the block.
Only inline Markdown will be parsed in titles.
By default, the plugin will produce the following two nodes, where whatnot
is the name of you block:
interface whatnotCustomBlock <: Parent {
type: "whatnotCustomBlock";
data: {
hName: "div" or "details";
hProperties: {
className: [string];
}
}
}
interface whatnotCustomBlockBody <: Parent {
type: "whatnotCustomBlockBody";
data: {
hName: "div";
hProperties: {
className: [string];
}
}
}
If your block has a heading, the following node will also be produced:
interface whatnotCustomBlockHeading <: Parent {
type: "whatnotCustomBlockHeading";
data: {
hName: "div" or "summary";
hProperties: {
className: [string];
}
}
}
npm:
npm install remark-custom-blocks
The configuration object follows this pattern:
trigger: {
classes: String, space-separated classes, optional, default: ''
title: String, 'optional' | 'required', optional, default: custom titles not allowed
containerElement: String, optional, default: 'div'
titleElement: String, optional, default: 'div'
contentsElement: String, optional, default: 'div'
details: Boolean, optional, default: false
}
containerElement
, titleElement
, contentsElement
allow you to customize the html elements that will be generated by remark-rehype
stringifier. The generated HTML structure will be
<containerElement>
<titleElement>
block title
</titleElement>
<contentsElement>
block content
</contentsElement>
</containerElement>
you can see details: true
as a shortcut to
{
containerElement: 'details',
titleElement: 'summary',
contentsElement: 'div',
}
Those specific parameters are here to help you build semantic HTML structure.
const unified = require('unified')
const remarkParse = require('remark-parse')
const stringify = require('rehype-stringify')
const remark2rehype = require('remark-rehype')
const remarkCustomBlocks = require('remark-custom-blocks')
unified()
.use(remarkParse)
.use(remarkCustomBlocks, {
foo: {
classes: 'a-class another-class'
},
bar: {
classes: 'something',
title: 'optional'
},
qux: {
classes: 'qux-block',
title: 'required'
},
spoiler: {
classes: 'spoiler-block',
title: 'optional',
details: true
},
})
.use(remark2rehype)
.use(stringify)
The sample configuration provided above would have the following effect:
Allows you to use the following Markdown syntax to create blocks:
[[foo]]
| content
[[bar]]
| content
[[bar | my **title**]]
| content
[[qux | my title]]
| content
[[spoiler | my title]]
| content
foo
cannot have a title, [[foo | title]]
will not result in a block.bar
can have a title but does not need to.qux
requires a title, [[qux]]
will not result in a block.This Remark plugin would create mdast nodes for these two blocks, these nodes would be of type:
fooCustomBlock
, content will be in fooCustomBlockBody
barCustomBlock
, content in barCustomBlockBody
, optional title in barCustomBlockHeading
quxCustomBlock
, content in quxCustomBlockBody
, required title in quxCustomBlockHeading
If you're using rehype, you will end up with these 4 div
s and 1 details
:
<div class="custom-block a-class another-class">
<div class="custom-block-body"><p>content</p></div>
</div>
<div class="custom-block something">
<div class="custom-block-body"><p>content</p></div>
</div>
<div class="custom-block something">
<div class="custom-block-heading">my <strong>title</strong></div>
<div class="custom-block-body"><p>content</p></div>
</div>
<div class="custom-block qux-block">
<div class="custom-block-heading">my title</div>
<div class="custom-block-body"><p>content</p></div>
</div>
<details class="custom-block spoiler-block">
<summary class="custom-block-heading">my title</summary>
<div class="custom-block-body"><p>content</p></div>
</details>
FAQs
This plugin parses custom Markdown syntax to create new custom blocks. It adds new nodes types to the [mdast][mdast] produced by [remark][remark]:
The npm package remark-custom-blocks receives a total of 1,546 weekly downloads. As such, remark-custom-blocks popularity was classified as popular.
We found that remark-custom-blocks demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.