GitHub如何编写README.md项目自述文件
来源:互联网 发布:mysql 默认访问地址 编辑:程序博客网 时间:2024/05/01 15:42
一:
建好项目后:
A:
B:
C:
D:
下面可以进行编辑了
1、编辑README文件
大标题(一级标题):在文本下面加等于号,那么上方的文字就变成了大标题,等于号的个数无限制,但一定要大于0
大标题====
中标题(二级标题):在文本下面加下划线,那么上方的文本就变成了中标题,下划线个数无限制,中标题比大标题低一级
中标题-------
1~6级标题:文本大小依次减小,以#号开头,多少个#号就是多少级标题,#号和标题名称要并排写
#一级标题##二级标题###三级标题####四级标题#####五级标题######六级标题
插入圆点符号:编辑的时候使用的是星号 *,星号后面要有一个空格,否则为普通星号
* 列表一* 列表二* 列表三
二级圆点、三级圆点:多加一个Tab,即第二行一个Tab,第三行两个Tab
* 列表一 * 列表二 *列表三
缩进:
>缩进一>>缩进二>>>缩进三>>>>缩进四>>>>>缩进五
插入网络图片:![](网络图片链接地址),即叹号!+方括号[]+括号(),如果不加叹号!就会变成普通文本,方括号里可以加入一些 标识性的信息
![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")
插入GITHub仓库里的图片:![](图片链接地址),即叹号!+方括号[]+括号(),URL写法:http://github.com/自己的用户名/项目名/raw/分支名/存放图片的文件夹/文件夹里的图片名字
给图片加上超链接:即点击一个图片进入指定网页,方括号里写自己起的标识名称,上下两行标识要一致。
[![baidu]](http://baidu.com) [baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"
插入代码片段:在代码上下行用```标记,注意`符号是tab键上面那个,要实现语法高亮,则在```后面加上编程语言的名称
```Javapublic static void main(String[] args){}``````javascriptdocument.getElementById("ts").innerHTML="Hello"```
换行:使用标签<br>
单行文本:前面使用两个Tab
多行文本:每行行首加两个Tab
部分文字高亮:使用``包围,这个符号不是单引号,而是Tab上方,数字1左边那个按键的符号
文字超链接格式:[要显示的文字](链接的地址"鼠标悬停显示"),在URL之后用双引号括起来一个字符串,即鼠标悬停显示的文本,可不写
显示效果:
你还可以给他加上一个鼠标悬停显示的文本。
- [我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")
插入符号
圆点符
- 这是一个圆点符
- 这也是一个圆点符
上面这段的圆点是CSDN博客编辑器里面的符号列表。写文章在列出条目时经常用到。在GitHub的markdown语法里也支持使用圆点符。编辑的时候使用的是星号 *
- * 昵称:果冻虾仁
- * 别名:隔壁老王
- * 英文名:Jelly
此外还有二级圆点和三级圆点。就是多加一个Tab。
- * 编程语言
- * 脚本语言
- * Python
如果你觉得三级的结构还不够表达清楚的话,我们可以试着换一种形式,请看字符包围
缩进
缩进的含义是很容易理解的。。
- >数据结构
- >>树
- >>>二叉树
- >>>>平衡二叉树
- >>>>>满二叉树
当然比这个更一般的用法是这样。常常能在书籍里面看到的效果,比如引用别人的文章。直接看效果。
GitHub仓库里的图片
有时候我们想显示一个GitHub仓库(或者说项目)里的图片而不是一张其他来源网络图片,因为其他来源的URL很可能会失效。那么如何显示一个GitHub项目里的图片呢?
其实与上面的格式基本一致的,所不同的就是括号里的URL该怎么写。
https://github.com/ 你的用户名 / 你的项目名 / raw / 分支名 / 存放图片的文件夹 / 该文件夹下的图片
这样一目了然了吧。比如:
- ![](https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif)
给图片加上超链接
如果你想使图片带有超链接的功能,即点击一个图片进入一个指定的网页。那么可以这样写:
- [![baidu]](http://baidu.com)
- [baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"
这样就能实现 点击图片进入网页的功能了。
- GitHub如何编写README.md项目自述文件
- 如何编写github项目的README.md文件?
- 【Github】为项目编写Readme.MD文件
- github上README.md文件如何编写
- 【GitHub】README.MD 编写
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- 为项目编写README.md文件
- 为项目编写Readme.MD文件
- 为项目编写Readme.MD文件
- Markdown编写github README.md
- github的README.md编写
- GitHub上的Readme.md文件的编写
- GitHub中README.md文件编写的基本用法
- github—如何在README.md文件中添加图片
- github—如何在README.md文件中添加图片
- Python好用的IDE推荐
- 字符输入/输出函数的format
- 海淘转运攻略之2017年黑色星期五海淘转运公司对比推荐
- request的常用方法
- Android底部导航栏——FragmentTabHost+ViewPager+Fragment
- GitHub如何编写README.md项目自述文件
- IOS逆向--MSHookFunction使用
- Fabled Rooks UVA
- 使用@InitBinder进行数据转换
- 任务2: 肤色检测
- EL表达式获取值栈数据
- maven根据build输入导入不同的配置
- 添加节点
- 选购扫地机器人必须要懂的三件事