npmpackage.info

@mdx-js/node-loader

Markdown for the component era

3.1.0

18,091

MIT

JavaScript

14.24 kB

64,252 5.2

Installations

npm install @mdx-js/node-loader

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

23.0.0

NPM Version

10.9.0 Score

66.6

Supply Chain

97.7

Quality

81.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

1,427

Closed

324

Merged

1,099

Issues

Open

5

Total

677

Closed

672

Releases

119

3.1.0

Updated on Oct 18, 2024

3.0.1

Updated on Feb 12, 2024

3.0.0

Updated on Oct 24, 2023

2.3.0

Updated on Feb 09, 2023

2.2.1

Updated on Dec 14, 2022

2.2.0

Updated on Dec 14, 2022

View All 119 releases

Contributors

190

View All 190 Contributors

Languages

JavaScript

MDX

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

mdx-js

Download Statistics

Total Downloads

64,252

Last Day

Last Week

368

Last Month

1,962

Last Year

34,667

GitHub Statistics

MIT License

18,091 Stars

1,752 Commits

1,147 Forks

88 Watchers

6 Branches

190 Contributors

Updated on Feb 21, 2025

Sponsor this package

https://opencollective.com/unified

Maintainers

Package Meta Information

Latest Version

3.1.0

Package Id

@mdx-js/node-loader@3.1.0

Unpacked Size

14.24 kB

Size

5.62 kB

File Count

NPM Version

10.9.0

Node Version

23.0.0

Published on

Oct 18, 2024

Total Downloads

Cumulative downloads

Total Downloads

64,252

Last Day

25.5%

Compared to previous day

Last Week

13.9%

368

Compared to previous week

Last Month

14.3%

1,962

Compared to previous month

Last Year

52.6%

34,667

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@mdx-js/mdx source-map vfile-reporter vfile

`@mdx-js/node-loader`

Node.js hooks (also knows as loaders) for MDX.

What is this?
When should I use this?
Install
Use
API
Types
Compatibility
Security
Contribute
License

What is this?

This package contains Node.js hooks to add support for importing MDX files. Node Customization Hooks are currently a release candidate.

When should I use this?

This integration is useful if you’re using Node and want to import MDX files from the file system.

If you’re using a bundler (webpack, Rollup, esbuild), or a site builder (Next.js) or build system (Vite) which comes with a bundler, you can instead another integration: see § Integrations.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install @mdx-js/node-loader

Use

Say we have an MDX document, example.mdx:

1export function Thing() {
2  return <>World!</>
3}
4
5# Hello, <Thing />

…and our module example.js looks as follows:

1import {renderToStaticMarkup} from 'react-dom/server'
2import React from 'react'
3import Content from './example.mdx'
4
5console.log(renderToStaticMarkup(React.createElement(Content)))

…then running with:

1node --loader=@mdx-js/node-loader example.js

…yields:

1<h1>Hello, World!</h1>

Note: if you use Node 18 and lower, then you can ignore the following warning:

1(node:20718) ExperimentalWarning: Custom ESM Loaders is an experimental feature and might change at any > time
2(Use `node --trace-warnings ...` to show where the warning was created)

Note: if you use Node 20 and higher, then you get the following warning:
1(node:20908) ExperimentalWarning: `--experimental-loader` may be removed in the future; instead use > `register()`:
2--import 'data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from > "node:url"; register("%40mdx-js/node-loader", pathToFileURL("./"));'
You can solve that by adding a register.js file:
1import {register} from 'node:module'
2
3register('@mdx-js/node-loader', import.meta.url)
…and running node --import ./register.js example.js instead.

API

This package export the identifiers createLoader and load. There is no default export.

`createLoader(options?)`

Create Node.js hooks to handle markdown and MDX.

Parameters

options (Options, optional) — configuration

Returns

Node.js hooks ({load}).

`load`

Load file: URLs to MD(X) files.

See load in Node.js docs for more info.

`Options`

Configuration (TypeScript type).

Options are the same as CompileOptions from @mdx-js/mdx exception that the development option is supported based on whether you run Node with --conditions development. You cannot pass it manually.

Types

This package is fully typed with TypeScript. It exports the additional type Options. See § Types on our website for information.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, @mdx-js/node-loader@^3, compatible with Node.js 16.

Security

See § Security on our website for information.

Contribute

See § Contribute on our website for ways to get started. See § Support for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

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.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

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 4

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/bb.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/website.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/mdx-js/mdx/website.yml/main?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 3 out of 3 npmCommand dependencies pinned

0

Code-Review

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

0

Token-Permissions

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

0

CII-Best-Practices

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

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

5.2

/10

Last Scanned on 2025-02-10

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

@mdx-js/node-loader

Installations

Developer Guide

Yes

ESM

23.0.0

10.9.0

Score

Pull Requests

4

1,427

324

1,099

Issues

5

677

672

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

64,252

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@mdx-js/node-loader

Contents

What is this?

When should I use this?

Install

Use

API

createLoader(options?)

Parameters

Returns

load

Options

Types

Compatibility

Security

Contribute

License

10

10

10

10

10

9

4

0

0

0

0

0

0

5.2

/10

`@mdx-js/node-loader`

`createLoader(options?)`

`load`

`Options`