Go to file

Rongjian Zhang 80fa166b1f feat: add react ssr example		2020-06-21 16:46:59 +08:00
.github/workflows	refactor: rename example	2020-06-21 15:23:33 +08:00
assets	improvement: sanitize strategy	2020-06-12 18:40:52 +08:00
examples	feat: add react ssr example	2020-06-21 16:46:59 +08:00
packages	fix: ssr render compatiable	2020-06-21 11:20:04 +08:00
scripts	chore: add icon script	2020-06-10 15:45:13 +08:00
.gitignore	feat: output css bundle	2020-06-10 20:45:05 +08:00
.prettierignore	build: fix readme generation of hyphen name	2020-03-31 19:20:35 +08:00
.prettierrc	style: prettier write	2020-05-11 21:20:52 +08:00
LICENSE	Initial commit	2020-02-10 20:32:52 +08:00
README.md	docs: update readme	2020-05-26 20:50:45 +08:00
package.json	build: external modules	2020-06-14 23:41:12 +08:00
rollup.config.js	build: external modules	2020-06-14 23:41:12 +08:00
tsconfig.json	refactor: new plugin system	2020-06-10 19:52:49 +08:00

README.md

ByteMD

Markdown editor component built with Svelte.

Note: It is still in development.

Usage

import { Editor, Viewer } from 'bytemd';

// Editor
new Editor({
  target: document.body,
  props: {},
});

// Viewer
new Viewer({
  target: document.body,
  props: {},
});

Plugins

Package	Status	Description
@bytemd/plugin-abc		support ABC notation
@bytemd/plugin-highlight		highlight code blocks
@bytemd/plugin-math	$npm$	support math equation
@bytemd/plugin-media		support `<video>` and `<audio>` tags
@bytemd/plugin-mermaid		support mermaid diagram and flowchart
@bytemd/plugin-styled-text		add styled text
@bytemd/plugin-twemoji		replace emoji characters with twemoji
@bytemd/plugin-xgplayer		support `<video>` with xgplayer

License

MIT