Markdown-editor-vuejs NPM

About The Project

Markdown Editor Screen Shot

Built With

Vue js

Getting Started

Prerequisites

npm install npm@latest -g

Installation

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.