npmpackage.info

Gathering detailed insights and metrics for remark-mdx-frontmatter

remark-mdx-frontmatter

A remark plugin for converting frontmatter metadata into MDX exports

5.0.0

102

MIT

TypeScript

33,744,177 4.5

Installations

npm install remark-mdx-frontmatter

Pull Requests

Open

0

Total

5

Closed

3

Merged

2

Issues

Open

0

Total

11

Closed

11

Releases

v5.0.0

Published on 21 Jun 2024

v4.0.0

Published on 26 Oct 2023

v3.0.0

Published on 23 Apr 2023

v2.1.1

Published on 27 Oct 2022

v2.1.0

Published on 26 Oct 2022

v2.0.3

Published on 21 Jul 2022

View all 13 releases

Developer

remcohaszing

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

22.3.0

NPM Version

10.8.1 Statistics

102 Stars

88 Commits

6 Forks

4 Watching

1 Branches

2 Contributors

Updated on 13 Nov 2024

Languages

TypeScript (53.46%)

JavaScript (46.54%)

Total Downloads

Cumulative downloads

Total Downloads

33,744,177

Last day

-11.1%

80,273

Compared to previous day

Last week

4.9%

497,429

Compared to previous week

Last month

12.5%

2,090,865

Compared to previous month

Last year

51.2%

18,784,788

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

remark-mdx-frontmatter

A remark plugin for converting frontmatter metadata into MDX exports

Installation
Usage
API
- Options
Compatibility
License

Installation

This package depends on the AST output by remark-frontmatter

1npm install remark-frontmatter remark-mdx-frontmatter

Usage

This remark plugin takes frontmatter content, and outputs it as JavaScript exports. Both YAML and TOML frontmatter data are supported.

For example, given a file named example.mdx with the following contents:

1---
2hello: frontmatter
3---
4
5Rest of document

The following script:

1import { readFile } from 'node:fs/promises'
2
3import { compile } from '@mdx-js/mdx'
4import remarkFrontmatter from 'remark-frontmatter'
5import remarkMdxFrontmatter from 'remark-mdx-frontmatter'
6
7const { value } = await compile(await readFile('example.mdx'), {
8  jsx: true,
9  remarkPlugins: [remarkFrontmatter, remarkMdxFrontmatter]
10})
11console.log(value)

Roughly yields:

1export const frontmatter = {
2  hello: 'frontmatter'
3}
4
5export default function MDXContent() {
6  return <p>Rest of document</p>
7}

API

The default export is a remark plugin.

Options

name: The identifier name of the variable the frontmatter data is assigned to. (Default: frontmatter).
parsers: A mapping A mapping of node types to parsers. Each key represents a frontmatter node type. The value is a function that accepts the frontmatter data as a string, and returns the parsed data. By default yaml nodes will be parsed using yaml and toml nodes using toml.

Compatibility

This project is compatible with Node.js 18 or greater.

License

MIT © Remco Haszing

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 5

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:88: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/remcohaszing/remark-mdx-frontmatter/ci.yaml/main?enable=pin
Info: 0 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

0

Code-Review

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

0

CII-Best-Practices

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.5

/10

Last Scanned on 2024-11-18

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

remark-mdx-frontmatter

Installations

Pull Requests

0

5

3

2

Issues

0

11

11

Releases

Developer

remcohaszing

Developer Guide

ESM

Yes

22.3.0

10.8.1

Statistics

Languages

Total Downloads

33,744,177

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

remark-mdx-frontmatter

Table of Contents

Installation

Usage

API

Options

Compatibility

License

10

10

10

10

10

8

5

0

0

0

0

0

0

0

4.5

/10