@vutk/yame

Yet another markdown editor.

Usage no npm install needed!

<script type="module">
  import vutkYame from 'https://cdn.skypack.dev/@vutk/yame';
</script>

README

YAME

Yet another markdown editor.

Features

  • Markdown lint
  • WYSIWYG Preview (Thanks HyperMD) OR Source / Preview side by side
  • Web Component

Run a demo

yarn dev

Build

yarn build

TODO

lint

  • 不规范 markdown 语法警告

快捷键

  • ctrl+l 选中文字插入链接
  • ctrl+i 选中文字斜体
  • ctrl+b 加粗
  • ctrl+q 引用

snippets + tab

  • [ 链接
  • ![ 图片
  • [b 加粗
  • [i 斜体
  • [bi/[ib 斜体加粗
  • [cb{lang} 代码块，lang 是可选的，表示语言
  • [x 任务列表（已完成）
  • [[ 任务列表（未完成）