Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
remark-captions
Advanced tools
This [remark][remark] plugin adds custom syntax to add a caption to elements which might benefit from a legend. It wraps the said element in a `figure` node with `figcaption` node as last child. It is particularly interesting for use with quotes, images,
This remark plugin adds custom syntax to add a caption to elements which might benefit from a legend. It wraps the said element in a figure
node with figcaption
node as last child. It is particularly interesting for use with quotes, images, tables, code blocks.
It follows a "whitelist" approach: for each mdast node type for which you want to allow captioning you'll have to add a configuration property mapping a node type to its caption "trigger".
> Do it or do it not, there is no try
Source: A little green man, with a saber larger than himself
This takes what follows Source:
until the end of the block containing Source:
and puts this inside a figcaption
mdast node. What precedes it becomes children of a figure
node, the last child of this figure
node being figcaption
.
Used with rehype
, it generates the corresponding HTML elements.
interface figure <: Parent {
type: 'figure'
data: {
hName: 'figure',
}
}
interface figcaption <: Parent {
type: 'figcaption'
data: {
hName: 'figcaption',
}
}
This plugin handles two different types of caption/legend nodes :
internalLegend
: when the caption, after being parsed by remark
, is inside the captioned element or inside its wrapping paragraph:
externalLegend
: when the caption, after being parsed by remark
, is outside the captioned element or after its wrapping paragraph:
npm:
npm install remark-captions
Dependencies:
const unified = require('unified')
const remarkParse = require('remark-parse')
const stringify = require('rehype-stringify')
const remark2rehype = require('remark-rehype')
const remarkCaptions = require('remark-captions')
Usage:
unified()
.use(remarkParse)
.use(remarkCaptions, {
external: {
table: 'Table:',
code: 'Code:',
math: 'Equation:',
},
internal: {
image: 'Figure:',
}
})
.use(remark2rehype)
.use(stringify)
By default, it features :
external = {
table: 'Table:',
code: 'Code:',
}
internal = {
blockquote: 'Source:',
image: 'Figure:',
}
This enables you to deal with such a code:
```python
a_highlighted_code('blah')
```
Code: My code *caption*
will yield
{
type: 'figure',
data: {
hName: 'figure'
},
children: [
{
type: 'code',
language: 'python',
value: '\na_highlighted_code(\'blah\')\n'
},
{
type: 'figcaption',
data: {
hName: 'figcaption'
}
children: [
{
type: 'text',
value: 'My code '
},
{
type: 'em',
children: [
{
type: 'text',
value: 'caption'
}
]
}
]
}
]
}
Tables are also supported, example:
head1| head2
-----|------
bla|bla
Table: figcapt1
Associated with remark-rehype
this generates a HTML tree encapsulated inside a <figure>
tag
<figure>
<table>
<thead>
<tr>
<th>head1</th>
<th>head2</th>
</tr>
</thead>
<tbody>
<tr>
<td>bla</td>
<td>bla</td>
</tr>
</tbody>
</table>
<figcaption>figcapt1</figcaption>
</figure>
FAQs
This [remark][remark] plugin adds custom syntax to add a caption to elements which might benefit from a legend. It wraps the said element in a `figure` node with `figcaption` node as last child. It is particularly interesting for use with quotes, images,
The npm package remark-captions receives a total of 557 weekly downloads. As such, remark-captions popularity was classified as not popular.
We found that remark-captions 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.