Skip to content

A package for rendering Markdown within Jupyter notebooks

License

Notifications You must be signed in to change notification settings

nteract/markdown

Folders and files

NameName
Last commit message
Last commit date
Sep 21, 2021
Jan 6, 2021
Jun 9, 2021
Apr 7, 2020
Apr 7, 2020
Apr 7, 2020
Apr 7, 2020
Apr 7, 2020
Apr 7, 2020
Apr 10, 2022
Jun 9, 2021
Jun 26, 2020
Apr 7, 2020

Repository files navigation

@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 the examples.

Support

If you experience an issue while using this package or have a feature request, please file an issue on the issue board.

License

BSD-3-Clause

About

A package for rendering Markdown within Jupyter notebooks

Resources

License

Stars

Watchers

Forks

Packages

No packages published