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

gatsby-plugin-mdx-code-demo

v2.0.0

Published

Gatsby plugin to generate code demos from JavaScript files

Downloads

52

Readme

gatsby-plugin-mdx-code-demo

Create inline code demos with MDX. This plugin is heavily inspired by material-ui's wonderful documentation. It allows you to write demos like theirs.

Breaking changes in v2. The usage is radically simplified compared to v0 and v1, but they are totally uncompatible.

Example usage

To enable a CodeDemo just add the codeDemo metadata after the language in your MDX code block. The React component you want to demo needs to be default exported.

---
title: Buttons Documentation
---

## Buttons

Here is an example Button in action:

```jsx codeDemo
import React from 'react';
import Button from '@material-ui/core/Button';

function OutlinedButtons() {
  return (
    <>
      <Button variant="outlined">Default</Button>
      <Button variant="outlined" color="primary">
        Primary
      </Button>
      <Button variant="outlined" color="secondary">
        Secondary
      </Button>
      <Button variant="outlined" disabled>
        Disabled
      </Button>
      <Button variant="outlined" href="#outlined-buttons">
        Link
      </Button>
    </>
  );
}

// Demos must be default exported
export default OutlinedButtons;
```

Install

npm install --save gatsby-plugin-mdx gatsby-plugin-mdx-code-demo

Setup

  1. Add gastby-plugin-mdx-code-demo to your gastby-config.js file
// In your gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-plugin-mdx',
    options: {
      gatsbyRemarkPlugins: ['gatsby-plugin-mdx-code-demo'],
    },
  },
];
  1. Create a CodeDemo component. To highlight the code block you can use prism-react-renderer.
// src/components/CodeDemo.js
import React from 'react';

// This is a container component to render our demos and their code
export function CodeDemo(props) {
  const { code, children } = props;

  return (
    <div>
      <pre>{code}</pre> {/* code block as a string */}
      <div>
        {children} {/* the react rendered demo */}
      </div>
    </div>
  );
}
  1. Make CodeDemo available through your MDXProvider
// src/components/Layout.js
import React from 'react';
import { MDXProvider } from '@mdx-js/react';
import { CodeDemo } from './CodeDemo';

function Layout(props) {
  const mdxComponents = {
    h1: (props) => <h1 {...props} />,
    // more components
    CodeDemo: (props) => <CodeDemo {...props} />,
  };

  return <MDXProvider components={mdxComponents}>{props.children}</MDXProvider>;
}

export default Layout;

FAQ?

  1. How does it differ from react-live?
    react-live will let you live edit your views, but it brings buble as a dependency. All of gatsby-plugin-mdx-code-demo's magic happens at build time, so there is no dependency included. If you don't expect your users to edit your demos in real time react-live is probably overkill.

  2. How does it differ from react-view?
    The same as above applies to react-view, except react-view brings in babel as a dependency. Also, react-view doesn't currently work with Gatsby.