看很多人说研发同学要用markdown写文档,效率高什么的,但是作为一个前端,一直没找到markdown的使用场景?请各位大牛指导我一下,谢谢啦。
看很多人说研发同学要用markdown写文档,效率高什么的,但是作为一个前端,一直没找到markdown的使用场景?请各位大牛指导我一下,谢谢啦。
markdown学习起来也非常简单,应用场景的话最多的是用在写博客了,作为一个开发者基本上markdown是必备技能。
应用场景的话,举个栗子,比如一些技术服务型公司,可能需要提供一些对外提供的API文档,这个时候这些文档可以使用使用markown编写,然后用webpack的markdown-loader
把.md
的文件编译成chunk,也就是js代码,这样你就可以不使用html来编写API文档了。
markdown 语法很简单的,可以学习下哈,像写博客,markdown,或者github项目 中的 readme 都 是 markdown语法 的,学习成本很低的哈,没多少内容 !
跟你要学的html,css,js
比起来,markdown
就是小毛毛雨啦.
找个文档撸一遍,把常用的结构记一下,练习一下,像标题 列表 图片 链接 代码块,半个小时够了.
其他的像表格之类,每个平台各自的差异,要用到在去查一下,用几次就记住了.
学习成本低,收益高,何必纠结呢.
对于工程师来说,所有需要使用文档的场景都是markdown的使用场景,尤其是一些自用文档,使用md文件意味着你不需要单独再开一个软件,直接在IDE/编辑器里打开就行了。至于Word/PDF,那是面向PM/用户/老板用的格式?
另外,markdown格式简单易学,而Word,开个软件等十几秒(我笔记本预装的正版Office2016),然后还得琢磨对面用WPS+网上复制粘贴导致的格式兼容问题及样式表混乱导致的版式错乱……真的比md要麻烦多了。。
10 回答11.2k 阅读
5 回答4.9k 阅读✓ 已解决
4 回答3.2k 阅读✓ 已解决
2 回答2.8k 阅读✓ 已解决
3 回答4.9k 阅读✓ 已解决
1 回答3.3k 阅读✓ 已解决
3 回答2.4k 阅读✓ 已解决
谢邀。
markdown
学起来还是很简单的。不知道你问的场景指啥。
gihtub
上的README.md
。就比如
segmentfault
的回答问题的输入框就支持markdown
,我写回答就是用markdown
写的。掘金、简书等编辑器都支持
markdown
语法。MarkDown - 语法说明
Markdown 语法说明(简体中文版)
自己还可以搜索一些资料学习下,稍微学习下就能支撑很多场景。