https://github.com/collaborne/mwc-markdown-editor

Last synced: about 1 year ago
JSON representation

A markdown editor following Material Design spec

README

# \

A markdown editor following [Material Design spec](http://material.io/). The editor is based on [Prosemirror](https://prosemirror.net/).

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

![screenshot](doc/screenshot.png)

## Installation
```bash
npm i mwc-markdown-editor
```

## Usage
```html

import 'mwc-markdown-editor';

```

## Linting with ESLint, and Types
To scan the project for linting errors, run
```bash
npm run lint
```

You can lint with ESLint individually as well
```bash
npm run lint:eslint
```

To automatically fix many linting errors, run
```bash
npm run format
```

You can format using ESLint individually as well
```bash
npm run format:eslint
```

## Testing with Karma
To run the suite of karma tests, run
```bash
npm run test
```

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

```bash
npm run test:watch
```

## Demoing with Storybook
To run a local instance of Storybook for your component, run
```bash
npm run storybook
```

To build a production version of Storybook, run
```bash
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`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`