npmpackage.info

Gathering detailed insights and metrics for @orbiting/remark-preset

@orbiting/remark-preset - 1.2.4 | npmpackage.info

@orbiting/remark-preset

Mdast utils developed at Project R. Tools for rendering, serializing and specifying markdown documents.

1.2.4

JavaScript

41.17 kB

1.5

Installations

npm install @orbiting/remark-preset

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.9.4

NPM Version

5.6.0 Pull Requests

Open

0

Total

10

Closed

5

Merged

5

Issues

Open

0

Total

1

Closed

1

Releases

Unable to fetch releases

Languages

JavaScript

Shell

JavaScript (97.83%)

Shell (2.17%)

Developer

orbiting

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

14 Stars

81 Commits

2 Forks

1 Watchers

5 Branches

5 Contributors

Updated on Jun 21, 2023

Maintainers

View All 5 Contributors

Package Meta Information

Latest Version

1.2.4

Package Id

@orbiting/remark-preset@1.2.4

Unpacked Size

41.17 kB

Size

8.71 kB

File Count

NPM Version

5.6.0

Node Version

8.9.4

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

js-yaml parse-entities remark-frontmatter remark-parse remark-stringify stringify-entities unified

Dev Dependencies

babel-cli babel-preset-env babel-tape-runner faucet rimraf tape

Remark Preset

Preconfigured remark for our projects.

API

`parse`

1import { parse } from '@orbiting/remark-preset'
2
3parse(md): Mdast

md: String
The markdown to parse.

Returns a mdast tree.

`stringify`

1import { stringify } from '@orbiting/remark-preset'
2
3stringify(mdast): String

mdast: Object
The mdast tree to stringify.

Returns a markdown string.

Features

Custom Mdast Type `zone`

1<section><h6>IDENTIFIER</h6>
2
3Group arbitrary markdown
4
5<hr /></section>

Yields following AST:

1{
2  type: 'zone',
3  identfier: 'IDENTIFIER',
4  children: [{type: 'paragraph', children: [
5    {type: 'text', value: 'Group arbitrary markdown'}
6  ]}]
7}

Zones can be nested and can have data (stringified as json in a code node). Under the hood the zone type is expanded and collapsed into flat nodes wrapped by html nodes with the section markup.

`sub` and `sup` Types

1# CO<sub>2</sub>
2
340 µg/m<sup>3</sup>

Yields following AST:

1[
2  {
3    type: 'heading',
4    depth: 1,
5    children: [
6      {type: 'text', value: 'CO'},
7      {
8        type: 'sub',
9        children: [
10          {type: 'text', value: '2'}
11        ]
12      }
13    ]
14  },
15  {
16    type: 'paragraph',
17    children: [
18      {type: 'text', value: '40 µg/m'},
19      {
20        type: 'sup',
21        children: [
22          {type: 'text', value: '3'}
23        ]
24      }
25    ]
26  }
27]

`span` Type

Need custom inline nodes? Use span.

1<span data-number="10000">10'000</span>

Yields following AST:

1{
2  type: 'paragraph',
3  children: [
4    {
5      type: 'span',
6      data: {
7        number: '10000'
8      },
9      children: [
10        {
11          type: 'text',
12          value: '10\'000'
13        }
14      ]
15    }
16  ]
17}

node.data must be a flat object with only strings. Each key gets mapped to its own data attribute. You can store complex data, if you really need to, by using one key with stringified json.

Meta Data

Yaml meta data on root.meta. Powered by js-yaml and remark-frontmatter.

Utils

If want only want the features and configure the unified processors yourself, you can import them individually:

1import unified from 'unified'
2import remarkStringify from 'remark-stringify'
3import remarkParse from 'remark-parse'
4import frontmatter from 'remark-frontmatter'
5
6import * as meta from '@orbiting/remark-preset/lib/meta'
7import * as zone from '@orbiting/remark-preset/lib/zone'
8import * as tag from '@orbiting/remark-preset/lib/tag'
9import * as span from '@orbiting/remark-preset/lib/span'
10
11unified()
12  .use(remarkParse, {
13    // your options
14  })
15  .use(frontmatter, ['yaml'])
16  .use(meta.parse)
17  .use(zone.collapse({
18    test: ({type, value}) => {
19      // your logic
20    },
21    mutate: (start, nodes, end) => {
22      // your logic
23      return {
24        type: 'zone',
25        children: nodes
26      }
27    }
28  }))
29  .use(span.collapse)
30  .use(tag.collapse('sub'))
31
32const stringifier = unified()
33  .use(remarkStringify, {
34    // your options
35  })
36  .use(frontmatter, ['yaml'])
37  .use(meta.format)
38  .use(zone.expand({
39    test: ({type}) => type === 'zone',
40    mutate: (node) => {
41      // your logic
42      return [
43        {
44          type: 'html',
45          value: `<section>`
46        },
47        ...node.children,
48        {
49          type: 'html',
50          value: '</section>'
51        }
52      ]
53    }
54  }))
55  .use(span.expand)
56  .use(tag.expand('sub'))

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

107 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-gmwp-3pwc-3j3g
Warn: Project is vulnerable to: GHSA-446m-mv8f-q348
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-57cf-349j-352g
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-3f95-r44v-8mrg
Warn: Project is vulnerable to: GHSA-28xr-mwxg-3qc8
Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2
Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-v2p6-4mp7-3r9v
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-mvjj-gqq2-p4hw
Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp

Score

1.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@orbiting/remark-preset

Installations

Developer Guide

No

CommonJS

8.9.4

5.6.0

Pull Requests

0

10

5

5

Issues

0

1

1

Releases

Unable to fetch releases

Languages

Developer

orbiting

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Remark Preset

API

parse

stringify

Features

Custom Mdast Type zone

sub and sup Types

span Type

Meta Data

Utils

10

0

0

0

0

0

0

0

0

1.5

/10

`parse`

`stringify`

Custom Mdast Type `zone`

`sub` and `sup` Types

`span` Type