Markdown Github
Markdown Github
Github对Markdown支持还是很好的;毕竟Markdown天生对代码就比较友好;
Gitub默认的项目说明是 README.md
;
README.md
文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在标准的markdown语法基础上做了扩充,称之为GitHub Flavored Markdown。简称GFM,GFM在GitHub上有广泛应用,除了README文件外,issues和wiki均支持markdown语法。
如果你要是打算为自己的项目创建说明,或者写一些说明文档;
那Markdown是你的最佳选择;
Github主要是 Diff语法不错
版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。 GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。
其语法与代码高亮类似,只是在三个反引号后面写 diff ,
并且其内容中,以 + 开头表示新增,- 开头表示删除。
效果
+ 这是改后的代码
- 这是最初的代码