the-editor v0.1.0

The Editor

The Editor是一个极简markdown编辑器。仅提供了几个核心的基础 API：getValue, getHTML, getTOC, setValue。配置选项也非常精简，能满足大部分的需求场景。

👉 体验一下 👈

特性

• 模块化
• 极简 API
• markdown 代码高亮
• markdown 代码折叠
• 图片上传（粘贴）
• 实时预览
• Table of content（TOC）支持

快速开始

通过 NPM 引入

安装

yarn add the-editor
// or
npm i the-editor

使用

const editor = new TheEditor(editorElement, options);
// options=可选，具体属性见下文

以vue为例

// main.js
import 'the-editor/dist/the-editor.css'; // 引入样式

// app.vue
<template>
  <div ref="editor">
</template>
<script>
import { TheEditor } from 'the-editor'

export default {
  mounted() {
    const editor = new TheEditor(this.$refs.editor, {
      value: '# Hello The Editor'
    })
  }
}
</script>

通过 jsdelivr 引入

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/the-editor@0.1.0/dist/the-editor.min.css"
/>
<script src="https://cdn.jsdelivr.net/npm/the-editor@0.1.0/dist/the-editor.min.js"></script>

选项列表

所有选项均为可选

实例方法