npmpackage.info

Gathering detailed insights and metrics for @mdx-js/rollup

@mdx-js/rollup

Markdown for the component era

3.1.0

17,874

MIT

JavaScript

13.78 kB

3,718,837 5.1

Installations

npm install @mdx-js/rollup

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

23.0.0

NPM Version

10.9.0 Score

50.6

Supply Chain

97.4

Quality

82.1

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

7

Total

1,419

Closed

313

Merged

1,099

Issues

Open

6

Total

671

Closed

665

Releases

119

3.1.0

Published on 18 Oct 2024

3.0.1

Published on 12 Feb 2024

3.0.0

Published on 24 Oct 2023

2.3.0

Published on 09 Feb 2023

2.2.1

Published on 14 Dec 2022

2.2.0

Published on 14 Dec 2022

View all 119 releases

Contributors

193

Unable to fetch Contributors

View all 193 contributors

Languages

JavaScript

MDX

JavaScript (100%)

Developer

mdx-js

Download Statistics

Total Downloads

3,718,837

Last Day

6,730

Last Week

47,819

Last Month

213,037

Last Year

2,328,147

GitHub Statistics

17,874 Stars

1,743 Commits

1,138 Forks

88 Watching

10 Branches

193 Contributors

Sponsor this package

https://opencollective.com/unified

Maintainers

Package Meta Information

Latest Version

3.1.0

Package Id

@mdx-js/rollup@3.1.0

Unpacked Size

13.78 kB

Size

5.17 kB

File Count

NPM Version

10.9.0

Node Version

23.0.0

Publised On

18 Oct 2024

Total Downloads

Cumulative downloads

Total Downloads

3,718,837

Last day

-33.9%

6,730

Compared to previous day

Last week

-11.1%

47,819

Compared to previous week

Last month

-1.5%

213,037

Compared to previous month

Last year

113%

2,328,147

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@mdx-js/mdx @rollup/pluginutils source-map vfile

Peer Dependencies

rollup

Versions

`@mdx-js/rollup`

Rollup (and Vite) plugin for MDX.

What is this?
When should I use this?
Install
Use
API
- mdx(options?)
- Options
Examples
- Combine with Babel
Types
Compatibility
Security
Contribute
License

What is this?

This package is a Rollup (and Vite) plugin to support MDX.

When should I use this?

This integration is useful if you’re using Rollup (or another tool that uses Rollup, such as Vite).

This integration can be combined with the Babel plugin to compile modern JavaScript features to ones your users support.

If you want to evaluate MDX code then the lower-level compiler (@mdx-js/mdx) can be used manually.

Install

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

1npm install @mdx-js/rollup

Use

Add something along these lines to your rollup.config.js:

1/**
2 * @import {RollupOptions} from 'rollup'
3 */
4
5import mdx from '@mdx-js/rollup'
6
7/** @type {RollupOptions} */
8const config = {
9  // …
10  plugins: [
11    // …
12    mdx({/* jsxImportSource: …, otherOptions… */})
13  ]
14}
15
16export default config

See also ¶ Vite if you’re using Rollup through them for more info.

API

This package exports no identifiers. The default export is mdx.

`mdx(options?)`

Plugin to compile MDX w/ rollup.

Parameters

options (Options, optional) — configuration

Returns

Rollup (and Vite) plugin.

`Options`

Configuration (TypeScript type).

Options are the same as CompileOptions from @mdx-js/mdx with the exception that the SourceMapGenerator option is supported based on how you configure Rollup. You cannot pass it manually. When using Vite, the development option is also supported based on how you configure Vite.

There are also two additional options:

Fields

exclude (Array<RegExp | string>, RegExp, or string, optional) — picomatch patterns to exclude
include (Array<RegExp | string>, RegExp, or string, optional) — picomatch patterns to include

Examples

Combine with Babel

If you use modern JavaScript features you might want to use Babel through @rollup/plugin-babel to compile to code that works:

1/**
2 * @import {RollupOptions} from 'rollup'
3 */
4
5import mdx from '@mdx-js/rollup'
6import {babel} from '@rollup/plugin-babel'
7
8/** @type {RollupOptions} */
9const config = {
10  // …
11  plugins: [
12    // …
13    mdx({/* jsxImportSource: …, otherOptions… */}),
14    babel({
15      // Also run on what used to be `.mdx` (but is now JS):
16      extensions: ['.js', '.jsx', '.cjs', '.mjs', '.md', '.mdx']
17      // Other options…
18    })
19  ]
20}
21
22export default config

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/rollup@^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.

8

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: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/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/website.yml:12: 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:13: 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:18: 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:21: 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.1

/10

Last Scanned on 2024-12-16

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/rollup

Installations

Developer Guide

Yes

ESM

23.0.0

10.9.0

Score

Pull Requests

7

1,419

313

1,099

Issues

6

671

665

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

3,718,837

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

@mdx-js/rollup

Contents

What is this?

When should I use this?

Install

Use

API

mdx(options?)

Parameters

Returns

Options

Fields

Examples

Combine with Babel

Types

Compatibility

Security

Contribute

License

10

10

10

10

10

8

4

0

0

0

0

0

0

5.1

/10

`@mdx-js/rollup`

`mdx(options?)`

`Options`