<mwc-markdown-editor>

A markdown editor following Material Design spec. The editor is based on Prosemirror.

This webcomponent follows the open-wc recommendation.

Installation

npm i mwc-markdown-editor

Usage

<script type="module">
  import 'mwc-markdown-editor';
</script>

<mwc-markdown-editor></mwc-markdown-editor>

Linting with ESLint, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint individually as well

npm run lint:eslint

To automatically fix many linting errors, run

npm run format

You can format using ESLint individually as well

npm run format:eslint

Testing with Karma

To run the suite of karma tests, run

npm run test

To run the tests in watch mode (for TDD, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with es-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html