Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @nteract/markdown with all npm packages installed. Try it out:

var markdown = require("@nteract/markdown")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@nteract/markdown v4.0.0

Markdown/MathJax renderer for nteract

@nteract/markdown

This package contains components that allow us to render Markdown text per the Commonmark specification. It also supports rendering in-line and block math using the LaTeX syntax.

Installation

$ yarn add @nteract/markdown
$ npm install --save @nteract/markdown

Usage

The example below shows how we can use this package to render Commonmark-specified Markdown with LaTeX math.

import MarkdownRender from "@nteract/markdown";

export default () => {
  return (
    <MarkdownRender
      source={`Just some $\delta_{\alpha}$ math and __formatting__.`}
    />
  );
};

Documentation

You can view the reference documentation for @nteract/markdown in the component docs.

Support

If you experience an issue while using this package or have a feature request, please file an issue on the issue board and add the pkg:markdown label.

License

BSD-3-Clause

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free