@nteract/notebook-render
TypeScript icon, indicating that this package has built-in type declarations

5.0.4-alpha.0 • Public • Published

@nteract/notebook-render

This package provides a small React component that allows to render notebooks server-side with ReactDOMServer.renderToStaticMarkup(). Markdown is parsed with marked and maths are rendered with katex. To support rendering math with katex, you will need to include the katex.css stylesheet in your page.

Installation

$ yarn add @nteract/notebook-render
$ npm install --save @nteract/notebook-render

Usage

import NotebookRender from "@nteract/notebook-render";

export default () => {
  const reactComponent = React.createElement(
    NotebookRender,
    {
      notebook: notebook
    },
    null
  );

  const html = ReactDOMServer.renderToStaticMarkup(reactComponent);
  return html;
};

Documentation

We're working on adding more documentation for this component. Stay tuned by watching this repository!

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:notebook-render label.

License

BSD-3-Clause

Dependencies (12)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @nteract/notebook-render

    Weekly Downloads

    1

    Version

    5.0.4-alpha.0

    License

    BSD-3-Clause

    Unpacked Size

    25.1 kB

    Total Files

    9

    Last publish

    Collaborators

    • hydrosquall
    • benabel
    • alexandercbooth
    • benrussert
    • mpacer
    • theengineear
    • yuvipanda
    • rgbkrk
    • lgeiger
    • ivanov
    • captainsafia
    • peggyrayzis
    • jdetle
    • hasch
    • willingc
    • stormpython
    • crystalline-cat
    • emeeks