Markdown 编辑器
左边写、右边看,工具栏和大纲都摆在顺手的位置,正文只在你这台机器上。
草稿会自动存在浏览器本地,关掉页面再打开还在
插入语法
先选中文字再点按钮就是包住它;没选中就直接插入占位内容并选中,改掉即可。加粗、斜体、删除线、行内代码都是开关式的,再点一次就取消。快捷键:⌘/Ctrl + B、I、K、E。
正文
预览
项目说明
这是一个示例文档,用来说明 Markdown 的常见写法。
安装
npm install
npm run dev
要点
- 支持表格、任务列表和删除线
- 行内代码像这样:
npm run build - 链接:Nuxt 文档
| 命令 | 说明 |
|---|---|
| dev | 开发模式 |
| build | 生产构建 |
引用块用来放提示。
这段文字带删除线
大纲
大纲只认真正的标题语法,围栏代码块里的 # 会被跳过。点任意一条会跳到正文里对应的那一行。
统计与导出
- 字数99中文按字、英文按词
- 字符275含空格和标点
- 行数28
- 结构3 标题 · 1 链接 · 0 图片 · 1 代码块 · 1 表格
复制出去的 HTML 已经过一遍净化,<script> 之类的标签会被去掉。粘到别的 Markdown 平台前,记得确认那家对表格、任务列表的支持情况。
用之前值得知道的事
为什么还要一个本地编辑器。写 Markdown 最怕两件事:一是内容被迫上传到别人的服务器,二是网络一断就写不下去。这里没有账号、没有网络请求,草稿存在浏览器本地,关掉页面再打开还在。适合写不长但需要反复改的东西:README、发布说明、工单描述、给同事的说明文档。
草稿是自动存的,但要记得手动存真东西。正文改动会在停顿后写进浏览器的 localStorage。它是「关掉标签页不丢」级别的保护,不是备份:清理浏览器数据、换设备、隐私模式都会让它消失。真正要留下的内容,请导出成 .md 文件或复制走。
预览和最终渲染可能不一样。这里的预览用 markdown-it 加 GFM 扩展渲染,和 GitHub、GitLab 的观感基本一致,但各家对表格对齐、脚注、任务列表、数学公式的支持并不完全相同。尤其是公式和图表,各平台的方言差得很远,发布前最好在实际平台上再看一眼。
常用的其实只有八种写法。标题用 #,加粗用 **,斜体用 *,行内代码用反引号,代码块用三个反引号,链接是 [文字](网址),图片在前面加一个感叹号,列表用 - 或 1. 开头。日常写文档这八种覆盖了九成以上的需求,其余的都是锦上添花。