md是Markdown的缩写,md是一种易读易写的文本格式(easy-to-read, easy-to-write plain text format),并且可以很方便的转换成HTML格式显示在网页中. 以后项目的readme就可以用md格式编写了,下面列出了md格式的基本语法.   标题 Headings: # 标题 1 (对应HTML中的标签) ## 标题 2 (对应HTML中的标签) ...... ###### 标题 6 (对应HTML中的标签)   注意:标题与#之间要留一个空格   段…

README.MD文件 格式: 源码: # Hbase组件 ## Maven依赖 ``` <dependency> <groupId>catf</groupId> <artifactId>catf-hbase</artifactId> <version>2.0.3</version> </dependency> ``` ## 使用说明 + 参见Wiki <Hbase组件基础API使用说明> ## 更…

README.md 语法格式: 规范的README文件开头都写上一个标题,这被称为大标题. 标题: #一级标题 ##二级标题 ###三级标题 ####四级标题 #####五级标题 ######六级标题 超链接: [百度](http://www.baidu.com) 单行文本: 使用两个Tab符实现单行文本. 多行文本 多行文本和单行文本异曲同工,只要在每行行首加两个Tab 部分文字高亮 把它用 `  ` 包围起来.注意这不是单引号,而是Tab上方,数字1左边的按键(注意使用英文输入法). 前面有…

了解一个项目,恐怕首先都是通过其Readme文件了解信息.如果你以为Readme文件都是随便写写的那你就错了.github,oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的.称之为Markdown语法.基本规则如下: Markdown 语法速查表1 标题与文字格式标题# 这是 H1 <一级标题>## 这是 H2 <二级标题>###### 这是 H6 <六级标题>文字格式**这是文字粗体格式***这是文字斜体格式*~…

Markdown编写github README.md 一.在线编辑器StackEdit Markdown在线编辑器地址 中文:https://www.zybuluo.com/mdeditor 英文:https://stackedit.io/ 今天推荐一款web应用StackEdit,体验一流,功能强大. 进入后就是编辑界面,和一般的markdown相同,左边是MD代码,右侧是渲染后的文档预览. 貌似没神马特点嘛~markdown编辑器就是这样啦,基本功能上都一样,支持拼写检查,排版风格简洁美观.…

参考:https://github.com/HeTingwei/ReadmeLearn#%E7%BC%96%E5%86%99readme%E6%97%B6%E5%B8%B8%E7%94%A8%E7%9A%84%E5%86%99%E6%B3%95 # 编写README时常用的写法<br><br># 1级标题## 2级标题### 3级标题#### 4级标题**这个是粗体** <br>*这个是斜体* <br>***这个是粗体加斜体*** <br>```…

参考:https://github.com/guoyunsky/Markdown-Chinese-Demo/edit/master/README.md…

点击阅读原文 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们. README文件后缀名为md.md是markdown的缩写,markdown是一种编辑博客的语言.用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮.不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM.可不是GFW呀. ———————————————————…

最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们. README文件后缀名为md.md是markdown的缩写,markdown是一种编辑博客的语言.用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮.不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM.可不是GFW呀. ——————————————————————————…

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有 过什么了解.但是在看到别人写的项目的README.md里面竟然有图片.链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果, 竟迁出了一门从来没有了解过的语言— —Markdown! github上的README.md文件就是使用的Markd…