markdown-editor-vuejs

A light markdown editor with vuejs

Usage no npm install needed!

<script type="module">
  import markdownEditorVuejs from 'https://cdn.skypack.dev/markdown-editor-vuejs';
</script>

README


Markdown-Editor-Vue

A simple Markdown editor using VueJs
· Report Bug · Request Feature

Table of Contents

About The Project

Markdown Editor Screen Shot

Built With

Getting Started

Prerequisites

  • npm
npm install npm@latest -g

Installation

  1. Install NPM packages
npm install markdown-editor-vuejs

Usage

First, you have to import the newly installed package

// other import
import MarkdownEditor from 'markdown-editor-vuejs'
import 'markdown-editor-vuejs/src/markdown.css' // if you want to enjoy my style :)

export default {
    // your component code
    data: function() {
        return {
            content: '' //choose whatever name you want
        }
    }
}

Then, you can use the component anywhere in your template:

<template>
    <markdown-editor v-model="content"></markdown-editor>
</template>

You just need to bind the v-model to some data attribute

By default, this markdown editor has teal color theme but you can change it by passing a color prop.

The colors available are: gray - red - orange - yellow - green - teal - blue - indigo - purple - pink

You can also change the basic default theme to be lighter or darker

the themes available are: light - dark - basic

<markdown-editor v-model="content" color="blue" theme="dark"></markdown-editor>

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature)
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Mthdht - @mthdht - mthdht@gmail.com

Project Link: https://github.com/mthdht/markdown-editor-vue

Acknowledgements