Skip to content

FEMessage/v-editor

Repository files navigation

v-editor

Build Status NPM Download NPM Version NPM License PRs Welcome Automated Release Notes by gren

Lightweight rich text editor based on ckeditor5 and upload-to-ali.

view.png

中文文档

Table of Contents

Feature

  • File Upload : Integrated upload components, just configure the basic information of OSS (Configuration Reference), you can upload the picture or file to oss, support screenshot paste upload
  • Add Net Image: Can quickly add a net picture using the markdown picture syntax(![]()), or you can paste it directly
  • Fullscreen Editing: Allows the editor to cover the window

⬆Back to Top

Demo

⬆Back to Top

Install

# Upload image function depends on upload-to-ali component
yarn add @femessage/upload-to-ali @femessage/v-editor

⬆ Back to Top

Quick start

<!-- step1 Ensure oss config -->
<!-- step2 In the .vue file that needs to use the -->
renderer
<template>
  <v-editor v-model="content" />
</template>

<script>
  import VEditor from '@femessage/v-editor'

  export default {
    components: {
      VEditor
    },
    data() {
      return {
        content: ''
      }
    }
  }
</script>

⬆ Back to Top

Links

⬆ Back to Top

License

MIT

⬆ Back to Top

Contributors

Thanks goes to these wonderful people (emoji key):


kunzhijia

💻 🐛 📖

listars

🐛 📖

Donald Shen

🐛 📖 🔌 👀

levy

👀 🚇 🤔

ColMugX

💻 📝 🎨 🔌

snowlocked

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!