JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 721
  • Score
    100M100P100Q99902F
  • License MIT

Markdown in components, components in markdown

Package Exports

  • react-markings

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-markings) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-markings

Markdown in components, components in markdown

  • Allows you to write markdown using commonmark.js
  • Renders markdown as React elements using commonmark-react-renderer
  • Embed React components inside your markdown (in any paragraph position) like this:
import * as React from 'react';
import md from 'react-markings';

md`
  # react-markings

  > Markdown in components, components in markdown

  - Allows you to write markdown using [commonmark.js](https://github.com/commonmark/commonmark.js)
  - Renders markdown as React elements using [commonmark-react-renderer](https://github.com/rexxars/commonmark-react-renderer)
  - Embed React components inside your markdown (in any paragraph position) like this:

  ${<Example/>}
`;

function Example() {
  return (
    <pre>
      <code>...</code>
    </pre>
  );
}