npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rehype-mdx-fenced-code-meta-support

v1.0.4

Published

A rehype MDX plugin for interpreting meta data tags passed to fenced code blocks in mdx.

Downloads

1,312

Readme

A rehype MDX plugin for adding metadata to code elements.

Table of Contents

Why

With the latest version of mdx-js, random props could not be fetched if they were in format below -

```mdx path=google.com src=no-src
# Heading 1
```

This was working in mdx v1. This package adds a new prop named metaData for the fenced code blocks of the format path=google.com src=no-src which can be parsed using a regex and accessed in your custom code component.

Installation

npm install rehype-mdx-fenced-code-meta-support

OR

yarn add rehype-mdx-fenced-code-meta-support

Usage

This plugin adds metadata to code elements in the MDX.

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

```mdx path=google.com src=no-src
# Heading 1
```

The <code /> element now has a metaData prop containing the path=google.com src=no-src of the code block.

We are using this in gatsby with gatsby-plugin-mdx plugin like this:

...
import rehypeAddCodeMetaData from 'rehype-mdx-fenced-code-meta-support';
...
 {
        resolve: `gatsby-plugin-mdx`,
        options: {
          mdxOptions: {
            rehypePlugins: [rehypeAddCodeMetaData],
          },
        },
},
import React from 'react';
import { MDXProvider as Provider } from '@mdx-js/react';
const components = {
  code: (props) => {
    console.log("props", props);
    const metaDataObject = props.metaData.split(' ').reduce((obj, item) => {
        const [key, value] = item.split('=');
        obj[key] = value;
        return obj;
      }, {});

    return <Code {...props} path={metaDataObject.path} src={metaDataObject.src} />;
  },
}

const MDXProvider = ({ components = components, element }) => (
  <Provider components={{ ...components }}>
    {element}
  </Provider>
);

export default MDXProvider;

API

This package has a default export rehypeAddCodeMetaData.

rehypeAddCodeMetaData

An MDX rehype plugin for adding metadata to code elements.

Compatibility

This plugin works with Node.js 16 or greater and MDX 3.

License

MIT © Mudit Juneja