典型的 README 开头
源码
# Project Name
A short description in one or two sentences.
## Install
```bashnpm install project-name```
## Quick start
- Step 1- Step 2- Step 3标题、一段说明、放在代码块里的安装命令，再加一个无序列表，这就是每份好 README 的骨架。
Markdown 编辑器
编写 Markdown，左右分屏实时预览。
最后更新
准备好真正学会编程了吗？
Coddy 让你在浏览器里编写真实代码来学习：互动课程、即时反馈，卡住时还有 AI 帮忙。
Markdown 编辑器是什么？
Markdown 编辑器是一个左右分栏的写作环境：你在一侧输入纯文本的 Markdown，另一侧的渲染预览会实时更新。GitHub 上的 README、文档网站、静态网站生成器、博客平台、Obsidian 这样的笔记应用，以及 Discord 和 Slack 这样的聊天工具，用的都是这种格式。
Markdown 的核心理念是：纯文本状态下也易于阅读，渲染后又能变成结构化的 HTML。你花在排版工具栏上的时间更少，写作的时间更多，这正是技术写作者和开发者偏爱它的原因。
大多数现代 Markdown 编辑器都支持 GitHub 风格的 Markdown（GFM），它在最初的 CommonMark 规范之上增加了表格、任务列表、带语言标注的代码块、自动链接和删除线。
使用 Markdown 编辑器时你会学到
- Markdown 就是纯文本：在编辑器里可读，也能渲染成 HTML，没有工具栏，也没有隐藏的格式。
- 标题、列表、链接和强调能覆盖日常写作的 90%。表格和代码块能覆盖剩下 10% 中的大部分。
- 带语言标注的代码块（
```js、```python）在很多渲染器里会触发语法高亮。 - Markdown 在渲染时被转换成 HTML。只要用的是 CommonMark/GFM 渲染器，同一份源文件在哪里都会得到一致的输出。
Markdown 编辑器使用步骤
在左侧窗格开始输入
用
#写标题，用*或_表示强调，用-写列表。右侧窗格会随着你的输入实时更新。添加结构
插入标题、代码块和表格来组织文档。大多数编辑器都为常用格式提供了快捷键（
Ctrl+B、Ctrl+I）。预览渲染后的 HTML
对照实时预览和源码。如果某处渲染得和预期不一样，通常是源码里少了一个空行，或者代码块的围栏没有配对。
复制或下载
把 Markdown 源码复制到你的 README 里，或者把 HTML 复制到邮件、CMS 等不支持 Markdown 的地方。
Markdown 语法速查表
这些是你每天会用到的 80% 的 Markdown，其余的搜一下就能找到。规范：CommonMark 和 GitHub-Flavored Markdown。
| 元素 | Markdown | 渲染效果 |
|---|---|---|
| 一级标题 | # Title | 最高级标题 |
| 二级标题 | ## Section | 章节标题 |
| 粗体 | **strong** | **strong** |
| 斜体 | *emphasis* 或 _emphasis_ | *emphasis* |
| 行内代码 | `code` | code |
| 代码块 | 用三个反引号围住代码，可以加上语言标注 | 带语法高亮的代码块 |
| 链接 | [label](https://example.com) | 可点击的链接 |
| 图片 |  | 嵌入的图片 |
| 列表 | - item | 无序列表 |
| 编号列表 | 1. item | 有序列表 |
| 任务列表（GFM） | - [x] done | 已勾选的复选框 |
| 表格（GFM） | | a | b |\n|---|---|\n| 1 | 2 | | 两列表格 |
| 引用 | > quote | 缩进的引用块 |
可以试试的 Markdown 示例
表格（GitHub 风格）
源码
| Feature | Free | Pro ||---------|:----:|:---:|| Editor | ✓ | ✓ || Export | | ✓ |竖线（|）用来分隔列。短横线那一行用来划分表头，其中的 : 设置对齐方式（左、中、右）。GFM 表格不需要精确的列宽，只要结构对就行。
任务列表
源码
- [x] Draft the post- [x] Add screenshots- [ ] PublishGitHub 会在 issue 和 PR 里把它们渲染成可以勾选的复选框。适合做文档内的清单和轻量的项目跟踪。
Markdown 常见错误
- 忘了在列表、表格和代码块前后留空行。大多数渲染器需要一个空行才能开始新的块。
- 在列表里混用 Tab 和空格：有些渲染器会悄悄把缩进弄乱。
- 把原始 HTML 放进代码块里，还指望它被渲染。代码块里的内容是原样显示的，这正是它的用途。
- 以为所有 Markdown 都一样。CommonMark、GFM 和其他各种变体在细节上都有差异（换行、自动链接、内嵌 HTML）。
- 用
>来缩进而不是写引用。>本身就表示引用块，缩进请换别的方法。
Markdown 编辑器常见问题
Markdown 是什么？
Markdown 是一种轻量级标记语言，它把简单的纯文本语法（
# heading、**bold**、[link](url)）转换成排好版的 HTML。它的设计目标是源码本身也易于阅读。怎么把 Markdown 转换成 HTML？
把 Markdown 粘贴到 Markdown 编辑器里，然后复制渲染出的 HTML；或者运行
marked、markdown-it、pandoc 这样的转换工具。大多数静态网站生成器会在构建时自动完成这一步。Markdown 和 GitHub 风格的 Markdown 有什么区别？
GitHub 风格的 Markdown（GFM）在标准 Markdown 的基础上增加了表格、带语言标注的代码块、任务列表、自动链接和删除线。GitHub、GitLab 和很多文档平台用的都是这种方言。
可以在 Markdown 里写 HTML 吗？
可以，大多数渲染器会原样保留 HTML。它适合嵌入 Markdown 本身不支持的内容（自定义布局、video 标签），但这会让你的文档只能输出为 HTML。
这个 Markdown 编辑器保护隐私吗？
是的。Coddy 的编辑器完全在你的浏览器中渲染 Markdown，你的文本不会被上传到任何地方。
