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

1.0.0-beta.3 • Public • Published

🍞📝 TOAST UI Editor for Nuxt.JS

npm version badge npm bundle size badge npm download count badge MIT License badge

code style badge code of conduct Conventional Commits semantic-release

Easy integration on TOAST UI Editor for Nuxt.JS

🚧 This project is still under development and should not be used in a production environment. If you want to use tui-editor please refer to the issue nhn/toast-ui.vue-editor#24


📖 Release Notes

🏗 Setup

  1. Add @tui-nuxt/editor dependency to your project
    $ npm install --save @tui-nuxt/editor
    # or
    $ yarn add @tui-nuxt/editor
  2. Add @tui-nuxt/editor to the modules section of nuxt.config.js
    // nuxt.config.js
    const config = {
      modules: ['@tui-nuxt/editor']
    }
  3. Add <TuiEditor> or <TuiEditorViewer> tag for your source
    <template>
      <!-- wysiwyg editor -->
      <TuiEditor mode="wysiwyg" />
      
      <!-- markdown viewer -->
      <TuiEditorViewer :value="message" />
    </template>
    
    <script>
    export default {
      data () {
       return { message: '# Hello World' }
      }
    }
    </script>

🔼Top

Development

  1. Clone this repository
  2. Install dependencies (using yarn install or npm install)
  3. Start development server (using yarn dev or npm run dev)

🔼Top

👥 Contributing

Any contribute is welcome!

🔼Top

🤝 License

This project is MIT License

🔼Top

Package Sidebar

Install

npm i @tui-nuxt/editor

Weekly Downloads

37

Version

1.0.0-beta.3

License

MIT

Unpacked Size

19 kB

Total Files

29

Last publish

Collaborators

  • kygn1998