写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
哈喽,各位好!我是“数说编码”,一名工作十多年的程序员。
今天我们来聊聊每个程序员和技术写作者都应该掌握的技能——Markdown。
「Markdown」一种用符号代替排版的写作方式,通过简单符号就能实现:
✨ 美观的文档格式
📱 多平台兼容显示
⚡ 比 Word 快 3 倍的写作速度
写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
第一部分: 简介
(一)Markdown是啥玩意儿?
Markdown就是一种轻量级的标记语言,让你能够使用一种易读易写的纯文本格式进行写作,然后将其转换为结构有效的HTML(或者其他格式)。
发明这玩意儿的是John Gruber大神,目的就是让写作者专注于内容本身,而不是纠结于格式化。
个人觉得,这玩意儿简直就是为咱们程序员量身定做的写作工具。
(二)为什么要用Markdown?Word它不香吗?
估计不少人跟我当初一样,觉得Word、WPS这些富文本编辑器挺好的,为啥要折腾Markdown?
直到某天,我在写技术文档的时候,光是调个格式就花了半小时,一会儿字体不对,一会儿缩进有问题,最后还要到处兼容不同平台的格式...那一刻我真是醉了!
这时候才意识到,Markdown这玩意儿真不是可有可无的玩具,而是实打实的生产力工具:
专注内容 :不用被格式化打断思路,专心码字才是正经事
一稿多投 :写一次,到处都能用,再也不用为每个平台调整格式
版本管理友好 :纯文本格式,Git管理起来不要太爽
学习成本低 :几分钟就能上手,语法简单到哭
写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
第二部分: 工作原理
Markdown是一种纯文本标记语言,它允许你使用简单的符号来格式化文本,从而生成HTML文档。
创建 .md 文件
使用Markdown 应用程序(插件、APP、在线编辑器等)打开
使用 Markdown 应用程序将文件转换为 HTML 或其他格式
查看或导出结果
从你的角度来看,该过程将根据你使用的应用程序的不同而有所不同。例如,在线 Markdown 编辑器 (opens new window)本质上将第 1-3 步组合到一个单一、无缝的界面中,你要做的就是在左窗格中键入内容,然后转换结果就在右窗格中就神奇地出现了。 但是,如果你使用的是其他工具(例如带有静态网站生成器的文本编辑器),则会发现该过程更为明显。
写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
第三部分: 优缺点分析
优点:
简单易学 :语法简单到哭,几分钟就能上手
专注写作 :不用被复杂的格式化功能打断思路
跨平台兼容 :几乎所有写作平台都支持Markdown
版本控制友好 :纯文本格式,Git管理起来很舒服
可扩展性强 :各种编辑器和插件让你如虎添翼
缺点:
功能相对简单 :复杂排版需求可能满足不了
学习曲线 :对于非技术人员可能需要适应期
标准不统一 :不同平台可能支持的语法略有差异
那都不叫事,对于咱们技术人员来说,这些都不是问题。无所谓啦~
写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
第四部分: 基础语法
(一)标题
标题是文档结构的骨架,帮助读者快速把握文章脉络。在 Markdown 中,通过 # 符号创建标题层级。
在行首插入 1 到 6 个 #
,对应 1 到 6 级标题。
Markdown语法 | 渲染效果 |
---|---|
| 一级标题 |
| 二级标题 |
| 三级标题 |
| 四级标题 |
| 五级标题 |
| 六级标题 |
(二)段落和换行
一个 Markdown 段落由一个或多个连续文本行构成,其前后需有一个以上空行分隔;
若要实现换行效果,可在行尾添加两个及以上空格后回车。
渲染效果如下:
我是段落1,我后面有两个空格
我是段落2,我后面没有空格 我是段落3,我前面没有空格
(三)文本强调
文本强调是提升内容可读性和表达力的重要手段。合理的强调能够引导读者注意力,突出关键信息,增强文章的表现力。Markdown 提供了简洁直观的语法来实现文本的样式变化,包括斜体、粗体以及两者的组合。
一个 *
或 _
表示斜体,两个 *
或 _
表示加粗。
渲染效果如下:
我是斜体文本
我也是斜体文本
我是加粗文本
我也是加粗文本
我是粗体+斜体文本
我是粗体+斜体文本
(四)列表
Markdown 支持有序列表和无序列表。
无序列表
使用 *
或 -
或 +
作为列表标记,后跟一个空格,再输入列表内容。
渲染效果如下:
无序列表项1
无序列表项2
无序列表项3
无序列表项4
无序列表项5
无序列表项6
有序列表
使用数字加 .
作为标记,后跟一个空格,再输入列表内容。
渲染效果如下:
有序列表项1
有序列表项2
有序列表项3
嵌套列表
列表可以嵌套使用,创建多层次的结构
无序列表嵌套:
渲染效果如下:
水果
苹果
红苹果
绿苹果
橙子
橘子
橘橙
香蕉
梨
蔬菜
胡萝卜
白菜
有序列表嵌套:
渲染效果如下:
需求阶段
收集需求
分析需求
开发阶段
需求评审
需求开发
上线阶段
测试
运维
混合嵌套:
渲染效果如下:
主要任务
子任务A
子任务B
详细步骤1
详细步骤2
子任务C
次要任务
(五)链接
网址链接
链接让 Markdown 文档具有交互性,便于创建易于导航的内容。
语法格式:
几个实际例子:
邮箱和电话链接
锚点链接
(六)图片
图片能让文档更加生动和易于理解。
语法格式:
相对路径示例:
绝对路径示例:
直接引用网络图片:
Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 标签。
(七)引用块
在引用内容行首添加 >
符号表示引用。
单个段落引用
渲染效果如下:
多个段落的块引用
渲染效果如下:
嵌套块引用
渲染效果如下:
(八)分割线
分割线用于分隔文档内容,创建清晰的层次结构。
常用于章节分隔和内容区块分隔。
水平分割线的三种写法: ---
或 ***
或 ___
⚠️ 警告:
分割线必须独占一行(不能包含其他内容)
分割线前后最好都要添加空白行
渲染效果如下:
📝: 学会 Markdown 的语法,就像掌握了一种通用的写作语言,走到哪都能优雅地表达。
写作语言:Markdown简洁高效的文本标记语言,技术人的写作利器(简介及基础语法)
第五部分: 如何快速上手?
别想太多,直接开干就对了
选择一个编辑器 :推荐Typora、VS Code、MarkText等
找个教程 :网上一搜一大把,十分钟就能看完
动手写点什么 :新建个.md文件,随便写点东西试试
多用多练 :熟能生巧,用多了自然就熟悉了
第六部分: Markdown VS 富文本:谁才是真正的王者?
这个问题就像"可乐和雪碧哪个好喝"一样,没有标准答案,只有个人偏好。
对比维度 | Markdown | 富文本(如 Word、Google Docs) |
---|---|---|
编辑方式 | 使用纯文本 + 简单符号(如 | 使用按钮点击进行格式设置(如加粗、字体大小) |
文件格式 |
|
|
格式控制 | 通过符号定义结构和格式 | 所见即所得,直接调整字体、颜色、排版等 |
跨平台兼容性 | 极高,可在任意编辑器中打开 | 依赖特定软件,不同平台打开可能格式错乱 |
导出与转换 | 可轻松转换为 HTML、PDF、Word 等格式 | 支持导出多种格式,但格式依赖编辑器支持 |
图像与多媒体 | 支持插入图片,但无法调整大小、对齐等高级操作 | 支持插入图片、视频、表格、图表等,并可精细排版 |
协作与版本控制 | 与 Git 等版本控制系统天然兼容,易于多人协作 | 协作功能依赖特定平台(如 Google Docs),合并修改较复杂 |
学习成本 | 需要学习基础语法,适合喜欢高效写作的人 | 无需学习,直观易用,适合普通用户 |
适用场景 | 技术文档、博客、笔记、网页内容等 | 报告、简历、宣传材料、合同等需要精美排版的文档 |
第七部分: 数哥私藏资料推荐
编辑器推荐:
Typora :所见即所得,颜值很高(不过现在开始收费了)
Obsidian :笔记管理神器,Markdown支持超棒
VS Code :配合Markdown插件,功能强大
Intellij IDEA: JetBrains 公司的 IDEA,功能强大,支持Markdown
学习资源:
Markdown官方语法 - 最权威的资料
Markdown语法教程 - 详细全面的中文教程
Markdown菜鸟教程 - 适合初学者的入门教程
结语
Markdown这东西,说重要吧也不是核心技能,但说不重要吧,真能提升你的写作效率。掌握这个工具,能让你的技术写作之路顺畅不少。
本次分享就到这里,咱们下期再见!关注【数说编程】,持续更新技术、写作干货!🚀
如果这篇文章对你有帮助,欢迎关注、点赞、分享和在评论区交流讨论 👇