Giter Club home page Giter Club logo

echo-editor's Introduction

Echo Editor

A modern WYSIWYG rich-text editor base on tiptap uses shadcn-vue components.

MIT License

English | 中文

App Screenshot

Demo

Demo

Features

  • Use shadcn-vue components
  • Markdown support
  • TypeScript support
  • I18n support(en, zhHans)
  • Create your own extensions
  • Tailwind CSS support

Installation

  npm install echo-editor
  pnpm install echo-editor
  yarn add echo-editor

Usage

// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import EchoEditor from 'echo-editor'
import 'echo-editor/style.css'

const app = createApp(App)

app.use(EchoEditor)

app.mount('#app')

// App.vue
<script setup>
import {
  BaseKit,
} from 'echo-editor';

const extensions = [
  BaseKit.configure({
    placeholder: {
      placeholder: '请输入...',
    },
})]
</script>

<template>
<echo-editor
    :extensions="extensions"
/>
</template>

Run Locally

Clone the project

  git clone https://github.com/Seedsa/echo-editor.git

Go to the project directory

  cd echo-editor

Install dependencies

  pnpm install

Start the Demo server

  npm run build:lib
  npm run dev

Related

Here are some related projects

shadcn-vue

tiptap

iconify

License

MIT

echo-editor's People

Contributors

seedsa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.