【背景】
折腾:
【记录】将googlecode上面的crifanLib迁移到Github上
期间,在github上面编辑说明文档README.md:
想要搞清楚其中的语法。
【折腾过程】
1.目测是类似于wiki的语法。
搜:
github 语法
即可找到参考:
Github上README.md介绍 – 清雾沁仙 – ITeye技术网站
然后就可以去照葫芦画瓢了。
2.但是觉得其还是解释的不够清楚。
所以再去搜:
github readme.md syntax
找到:
GitHub Flavored Markdown – User Documentation
这些才是所需要的,官网的,标准和权威的解释。
并且官网提到了:
Markdown Basics – User Documentation
然后就可以根据其中解释的语法去编辑页面了。
3.最后编辑的内容是:
对应的效果:
【总结】
github中的编辑文件的界面中所用的语法,叫做markdown。
可以到官网中找到相关的语法介绍:
GitHub Flavored Markdown – User Documentation
Markdown Basics – User Documentation
转载请注明:在路上 » 【整理】github上编辑页面中所使用的语法