ByteMD
ByteMD is a Markdown editor component built with Svelte. It could also be used in other libraries/frameworks such as React, Vue and Angular.
Note: It is still in development
Features
- Lightweight and framework agnostic: ByteMD is built with Svelte. It compiles to vanilla JS DOM manipulation without importing any UI Framework runtime bundle, which makes it lightweight, and easily adapted to other libraries/frameworks.
- Easy to extend: ByteMD has a plugin system to extend the basic Markdown syntax, which makes it easy to add additional features such as code syntax highlight, math equation and Mermaid flowcharts. You can also write your own plugin if these ones don't meet your needs.
- Secure by default: Cross-site scripting(XSS) attack such as
<script>and<img onerror>have been correctly handled by ByteMD. No need to introduce extra DOM sanitize steps. - SSR compatiable: ByteMD could be used in the Server-side rendering(SSR) environment without extra config. SSR is widely used in some cases due to its better SEO and fast time-to-content in slow network connection.
Installation, Package, Status, Description, ---, ---, ---, bytemd, 
, Svelte/Vanilla JS component, @bytemd/react, 
, React component, @bytemd/vue, 
, Vue component, ## Usage
There are two components: Editor and Viewer. Editor is the Markdown editor, as the name suggests; Viewer is commonly used to display rendered Markdown results without editing.
Before using the component, remember to import CSS file to make styles correct:
import 'bytemd/dist/index.css';
Svelte
<script>
import { Editor, Viewer } from 'bytemd';
import gfm from '@bytemd/plugin-gfm';
let value;
const plugins = [
gfm(),
// Add more plugins here
];
function handleChange(e) {
value = e.detail.value;
}
</script>
<template>
<Editor {value} {plugins} on:change={handleChange} />
</template>
React
import { Editor, Viewer } from '@bytemd/react';
import gfm from '@bytemd/plugin-gfm';
const plugins = [
gfm(),
// Add more plugins here
];
const App = () => {
const [value, setValue] = useState('');
return (
<Editor
value={value}
plugins={plugins}
onChange={(v) => {
setValue(v);
}}
/>
);
};
Vue
<template>
<Editor :value="value" :plugins="plugins" @change="handleChange" />
</template>
<script>
import { Editor, Viewer } from '@bytemd/vue';
import gfm from '@bytemd/plugin-gfm';
const plugins = [
gfm(),
// Add more plugins here
];
export default {
components: { Editor },
data() {
return { value: '', plugins };
},
methods: {
handleChange(v) {
value = v;
},
},
};
</script>
Vanilla JS
import { Editor, Viewer } from 'bytemd';
import gfm from '@bytemd/plugin-gfm';
const plugins = [
gfm(),
// Add more plugins here
];
const instance = new Editor({
target: document.body, // DOM to render
props: {
value: '',
plugins,
},
});
instance.on('change', (e) => {
const value = e.detail.value;
console.log(value);
// ...
});
Technical details
ByteMD uses remark and rehype ecosystem to process Markdown. The complete process is as follows:
- The markdown text is parsed to an AST
- The Markdown AST could be manipulated by several remark plugins
- The Markdown AST is transformed to a HTML AST
- The HTML AST is sanitized for security reason
- The HTML AST could be manipulated by several rehype plugins
- The HTML AST is stringified to HTML
- Some extra DOM manipulation after the HTML being rendered
It could also be described as a flowchart:
The 2,5,7 steps are designed for user customization via ByteMD plugin API.
Plugins, Package, Status, Description, ---, ---, ---, @bytemd/plugin-breaks, 
, Support breaks, @bytemd/plugin-external-links, 
, Open external links in new window, @bytemd/plugin-footnotes, 
, Support footnotes, @bytemd/plugin-frontmatter, 
, Parse frontmatter, @bytemd/plugin-gemoji, 
, Support Gemoji shortcodes, @bytemd/plugin-gfm, 
, Support GFM (autolink literals, strikethrough, tables, tasklists), @bytemd/plugin-highlight, 
, Highlight code blocks, @bytemd/plugin-highlight-ssr, 
, Highlight code blocks (SSR compatible), @bytemd/plugin-import-html, 
, Import HTML by pasting or dropping, @bytemd/plugin-import-image, 
, Import image by pasting or dropping, @bytemd/plugin-inject-style, 
, Inject style to markdown body, @bytemd/plugin-math, 
, Support math equation, @bytemd/plugin-math-ssr, 
, Support math equation (SSR compatible), @bytemd/plugin-medium-zoom, 
, Zoom images like Medium, @bytemd/plugin-mermaid, 
, Support Mermaid diagram and flowchart, @bytemd/plugin-vega, 
, Support vega charts, ## Write a plugin
TODO
License
MIT