markdown 2025-02-20
Markdown:开发者的必备写作工具
通过本综合指南掌握用于文档、README 文件和技术写作的 Markdown 语法。
Markdown 是 John Gruber 于 2004 年创建的轻量级标记语言。它已成为开发者文档、README 文件和技术写作的标准。
为什么选择 Markdown?
- 简单语法:易学易读
- 可移植:纯文本文件在任何地方都能工作
- 广泛支持:GitHub、GitLab、Stack Overflow、Notion 等
- 版本控制友好:文本差异清晰有意义
基本语法
标题
标题 1
标题 2
标题 3
文本格式
粗体
斜体
~~删除线~~
行内代码
链接和图片
[链接文字](https://example.com)

编写优秀的 README 文件
1. 项目名称和描述
2. 安装说明
3. 带代码的使用示例
4. 配置选项
5. 贡献指南
6. 许可信息
使用我们的 Markdown 预览工具实时预览 Markdown。