Namely, Pickled Meatballs

    @curvenote/editor
    TypeScript icon, indicating that this package has built-in type declarations

    0.17.5 • Public • Published

    @curvenote/editor

    @curvenote/editor on npm MIT License CI demo

    An interactive scientific editor built with ProseMirror, React and Redux - by Curvenote.

    @curvenote/editor in curvenote.com

    Why

    We think that creating beautiful reactive documents and explorable explanations should be easy. Writing technical documents is hard enough already, and choosing to make that writing interactive is beyond the reach or time-commitment of most communicators.

    We aim to lower the barriers to writing computational narratives. Today, narrative is often moved out of computational notebooks into static document creation tools (Microsoft Word, Google Docs, LaTeX, Slides/PPT).

    We think this is for two reasons:

    1. The need for more expressive components, formatting or referencing.
      • CommonMark markdown does not support, for example, citations, cross-references, and even simple formatting like callouts (see various alternatives below).
    2. To enable collaborators and reviewers who don't use these tools (e.g. when writing and reviewing papers & reports, slide decks, etc.)
      • Writing often requires collaborators that may not be comfortable with some combination of the tools required for computational narratives (e.g. git, md, notebooks, javascript, etc.).

    Goals

    @curvenote/editor aims to bridge the gap between expressiveness and writing accessibility by developing a rich, WYSIWYG, collaborative editor with a focus on interactivity that integrates with LaTeX, various flavours of Markdown, and the Jupyter and Sphinx ecosystems.

    Overlap with Curvenote

    @curvenote/editor is the editor that is used in Curvenote, which is a scientific writing platform that connects to Jupyter.

    Architecture

    • Basic prosemirror, wrapped in a React component with some middleware in Redux.
    • Chosen to have many "blocks" of the editor on a page at once. See the UI in Curvenote as to what we are supporting - inspired in part by Jupyter.
      • If you only need one editor on the page, the weird part will be integrating with Redux, and some unnecessary indexing. However, this is probably important anyways if you have comments or other places in the DOM that are instances of the editor.
    • Typescript and fully typed.
    • Styling of editor components with material-ui
    • Reactivity powered by @curvenote/components and @curvenote/runtime, which are web components.
    • Real-time collaboration is possible through middleware integrations. See prosemirror-collab.
      • We will (eventually) improve support for cursors and highlights. See Roadmap.
    • See demo/index.tsx for an example setup.

    Getting Started

    git clone git@github.com:curvenote/editor.git
    cd editor
    npm install
    npm run start
    

    See the demo folder from more details on how to get started.

    Install

    npm i @curvenote/editor

    DownloadsWeekly Downloads

    129

    Version

    0.17.5

    License

    MIT

    Unpacked Size

    2.96 MB

    Total Files

    330

    Last publish

    Collaborators

    • fwkoch
    • rowanc1
    • stevejpurves