Non-Potable Macchiato

    web-editor-markdown
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.8 • Public • Published

    web-editor-markdown
    A markdown editor in browser, supports collaborative editing

    npm bundle size

    💡 Web Editor Markdown

    web-editor-markdown is a Markdown editor based on Web browser and real-time rendering like Typora. It is based on TypeScript and JavaScript, and does not rely on any third-party framework. It supports Chinese friendly and can be easily extended and connected to native JavaScript, Vue, React, Angular and other applications. It provides four rendering modes: SOURCE, SOURCE_AND_PREVIEW, RENDER and PREVIEW. If necessary, its underlying layer also supports the ability of collaborative editing and provides atomic Operation for extending collaborative editing.

    English Demo

    Chinese Demo

    🛠️ Getting started

    • install it
    npm install web-editor-markdown --save
    • use it
    import { Editor, withUndoRedo } from "web-editor-markdown";
    let editor = new Editor(document.getElementById('id'));
    editor = withUndoRedo(editor); // UndoRedo Plugin
    editor.insertTextAtCursor('**This is a bold text**\n> tips:You can switch source mode with `cmd+/`');
    • others
    import { EditorViewMode } from "web-editor-markdown";
    editor.switchViewMode(EditorViewMode.PREVIEW); // switch rendering mode,(shortcut key: 'cmd+/')
    console.log('content', editor.getContent());
    • local source
    npm install
    npm start

    Install

    npm i web-editor-markdown

    DownloadsWeekly Downloads

    26

    Version

    1.0.8

    License

    MIT

    Unpacked Size

    109 kB

    Total Files

    84

    Last publish

    Collaborators

    • zengyong