Markdown是否是一个程序员必会的文档编辑技能?


本人10年开发培训经验,期间经历了Java,Android,H5,大数据,PHP等多个不同的方向的开发,也做过软件培训公司的金牌讲师,很有兴趣回答你这个问题。

首先我觉得因为程序员也是分三六九等的,有的程序员天天就是写点业务代码,也涉及不到写文档,顶多就是看看别人写好的文档。在这种情况下,其实他不会Markdown文档编辑,也并不是什么丢人的事,毕竟编辑文档并不是每个公司对程序员的必然要求。

另外Markdown就是一个文本编辑器而已,无非就是对文档格式化做的比较好,既可以格式化文档标题,也可以更高级点,可以对代码块,表格,图片,超链接等进行编辑,最终写出一个比较好看的文档来。相对于普通的txt文档,也就是高级了这些,仅此而已。这有什么高级的呢?

如果要使用Markdown,我觉得只要是一个正常人,10分钟足够熟悉Markdown的使用了,没那么神奇也没有那么难。

还有就是即使我们不按照Markdown软件,现在有道云笔记,或者CSDN,知乎等网站,编写博客都可以直接在线Markdown格式或者富文本编辑器格式,最终做出来的效果都是一样的。

如图所示:

所以呢,要想写出一个格式良好的文档,Markdown并不是必须的,实现方案有很多,每个人的使用习惯不一样,只要最终的目标实现了,谁管你用哪个东西呢?


我从事开发培训10年,擅长Java,Android,H5,大数据,PHP等多个不同的技术方向。后续我会写一系列关于互联网技术方面的文章,感兴趣的朋友可以关注我。另外如果你有Java,Android,H5等开发方面,或者是求职方面的问题,也可以在评论区留言,或者私信我,相信一定会让你有所收获!


一一哥Sun


我觉得是的。

平时写技术文档时,基本都是用的markdown,代码块、流程图、序列图、甘特图、列表等应有尽有。非常方便程序员书写。

建议答主学会这个程序员必备的文档编辑技能,便于在日常的工作中提高沟通的效率,平时也可以用markdown,在github上提交自己的项目描述readme和搭建自己的博客。

1. 斜体和粗体
使用 * 和 ** 表示斜体和粗体。
示例:
这是 *斜体*,这是 **粗体**。


2. 标题
使用 #加空格表示一级标题,同理,##加空格表示二级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

3. 外链接
使用 [描述](链接地址) 为文字增加外链接。
示例:
这是去往 [我的博客](https://plutoyer.github.io/) 的链接。

4. 无序列表
使用 - 表示无序列表。
示例:
- 无序列表项 一- 无序列表项 二- 无序列表项 三


5. 有序列表
使用数字和点表示有序列表。
示例:
1. 有序列表项 一2. 有序列表项 二3. 有序列表项 三


6. 文字引用
使用 表示文字引用。
示例:
野火烧不尽,春风吹又生。

7. 行内代码块
使用 `代码` 表示行内代码块。
示例:
让我们聊聊 `html`。


8. 代码块
使用 四个缩进空格 或 ``` 表示代码块。
示例:
```这是一个代码块,此行左侧有四个不可见的空格。```


9. 插入图像

![image](图片链接)


10. 插入音乐
**插入单曲**在网易云音乐里找生成外连接,复制过来就OK了,可惜的是很多都不能生成外联连接。如果不想自动播放,可以把auto改成1[这一生关于你的风景](https://music.163.com/song/media/outer/url?id=1356350562.mp3)


匹诺曹的乌托邦


我是【会点代码的大叔】,每天为你分享程序员干货,关注并私信我数字“1”,送你一份程序员大礼包。


在我看来,一名程序员可以学习一下 Markdown ,但是并没有到非学不可的地步。


Markdown 是一种轻量级的【标记语言】,它让我们使用纯文本格式编写文档;这里提到的语言,并不是某种编程语言,也并不是只有程序员可以使用的。

通俗地说,Markdown 其实就是一套语法、一套规定,我们在编写文档的时候,增加一些符号,就可以达到某些效果,比如加粗、多级标题、列表等等;如图:


图 - 1,我们编辑的内容,可以看到我们使用了 #、##、``` 这些标记符号。


图 - 2,最后的效果



Markdown 的优点

  • Markdown 常用的标记符号也就十来个,就算是一个非程序员,学习这些标记符号也只需要几分钟的时间,而一旦熟悉了这种语法规则,会让我们文档编写的速度变得非常的快。
  • 让作者可以专注文字内容,而需要关心排版样式,可以更安心地写作;
  • 纯文本,你可以使用任何文本编辑器;
  • Markdown 默认的文件格式是 .md,不过也可以轻松地导出 HTML、PDF、Word 等等;

Markdown 的语法

  • 标题:在本段文字之前加 # 号,就表示一级标题,## 就是二级标题,最多可以到六级;
  • 列表:无序列表使用 - 或 * ;有序列表使用数字 1. 2. 3. ,符号或数字与文字之间有一个空格;
  • 引用:使用大于号 >;
  • 粗体:两个 ** 中间的文字,会被加粗;
  • 斜体:两个 * 中间的文字,会变成斜体;
  • 图片:![图片的备注](图片的地址);
  • 链接:[链接的文字](链接的地址);
  • 代码框:被两个 ``` 包裹起来;
  • 分割线:三个 * ;



我现在使用的 Typora 这个软件,现在很多网站也都支持 Markdown 语法,我们可以在本地编辑好,然后直接发布到这些网站上;这样可以让我专注写作内容,不需要花精力在格式上。


作者:会点代码的大叔 ,一个写代码的架构师,专注程序员的学习和成长,关注并私信我数字“1”,送你一份程序员大礼包。


分享到:


相關文章: