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

mdx-yaml-full

v2.0.0

Published

MDX transformer for yaml content.

Downloads

16

Readme

mdx-yaml-full

npm version

Description

A plugin for gatsby-transformer-yaml-full to parse MDX strings into MDX.

Installation

Run npm install --save mdx-yaml-full or yarn add mdx-yaml-full

Configuration

// gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-transformer-yaml-full',
      options: {
        plugins: [`mdx-yaml-full`]
      }
    }
    // ...
  ]
};

Usage

YAML File:

- name: 'Thing'
  content: !mdx |
    # Hello world

    I am MDX!

    - Much wow
    - Such **cool**

With the following GraphQL:

{
  # Depends on file name
  allFileYaml {
    nodes {
      name
      content {
        body
      }
    }
  }
}

Results in the following data:

{
  "data": {
    "allRemoveYaml": {
      "nodes": [
        {
          "name": "Thing",
          "content": {
            "body": "function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsxRuntime classic */\n\n/* @jsx mdx */\nvar layoutProps = {};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"h1\", null, \"Hello world\"), mdx(\"p\", null, \"I am MDX!\"), mdx(\"ul\", null, mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Much wow\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, \"Such \", mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"cool\"))));\n}\n;\nMDXContent.isMDXComponent = true;"
          }
        }
      ]
    }
  },
  "extensions": {}
}

Where content can be piped into the children of the MDXRenderer!

import React from 'react';
import { useStaticQuery, graphql } from 'gatsby';
import { MDXRenderer } from 'gatsby-plugin-mdx';

const Example = () => {
  const data = useStaticQuery(
    graphql`
      query {
        allFileYaml {
          nodes {
            name
            content {
              body
            }
          }
        }
      }
    `
  );

  const { name, content } = data.allFileYaml.nodes[0];

  return (
    <>
      <h1>{name}</h1>
      <MDXRenderer>{content.body}</MDXRenderer>
    </>
  );
};

License

This project is licensed using the MIT license.