GitHub ReadME.md

GitHub ReadME.md

GitHub ReadME.md Grammar

最近提交GitHub时发现有些人的ReadME.md写的非常漂亮,很好奇他们是怎么做到的,于是就搜了一下,原来ReadME.md不仅仅是随便写写的,它是由其特殊的语法的叫Markdown,刚好hexo写文章用的也是Markdown,所以这里列出一些基本的语法,以便于以后写ReadME.md时参考。

二、编辑基本语法 (注意??中间需要有一个空格 )

1、字体格式强调

我们可以使用下面的方式给我们的文本添加强调的效果

123456
*强调*  (示例:斜体)  	_强调_  (示例:斜体)  **加重强调**  (示例:粗体)  	__加重强调__ (示例:粗体)  ***特别强调*** (示例:粗斜体)  ___特别强调___  (示例:粗斜体)

标题等级

关于标题还有等级表示法,分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。例如:

123456
# 一级标题  ## 二级标题  ### 三级标题  #### 四级标题  ##### 五级标题  ###### 六级标题

2、代码

1
`<hello world>`

3、代码块高亮

三个反引号标签

4、表格 (建议在表格前空一行,否则可能影响表格无法显示)

1234
表头  | 表头  | 表头---- | ----- | ------  单元格内容  | 单元格内容 | 单元格内容 单元格内容  | 单元格内容 | 单元格内容

5、其他引用

图片
123
![图片名称](https://www.baidu.com/img/bd_logo1.png)链接  [链接名称](https://www.baidu.com/)

6、列表

12345
1. 项目1  2. 项目2  3. 项目3     * 项目1 (一个*号会显示为一个黑点,注意??有空格,否则直接显示为*项目1)    * 项目2

7、换行(建议直接在前一行后面补两个空格)

直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。

8、引用

12
> 第一行引用文字  > 第二行引用文字

Share

  • GitHub ReadME.md

原文地址:https://www.cnblogs.com/yezhanpeng/p/9829063.html

时间: 2024-10-19 14:51:38

GitHub ReadME.md的相关文章

github README.md创建不了

在项目主页上,点击‘Add a README’按钮,如下图: 进入编辑界面,编辑好内容后,提交按钮的状态为灰化不可点击,如下图: 不知道为什么会出现这种情况,但是我无意中点击了Ctrl+Enter竟然提交成功了,这.....得记下来. github README.md创建不了

Github README.md中添加图片

1.先把图片上传到你的项目中:然后在github网站上按路径打开图片,如下打开的图片链接: 2.复制图片的地址 3.然后在README.md写上: ![这里随便写文字](你刚复制的图片路径) 注意  上面的感叹号和中括号和小括号之间不能有空格(都是英文状态下的) 然后保存就能看到下面的效果,赶快试试吧: 原文地址:https://www.cnblogs.com/it-noob/p/10165542.html

在Github README.md中插入图片以及代码高亮

1.插入图片: 首先在项目根目录建个存图片的文件夹放入图片,提交这个目录,在github里找到这张图片,复制图片连接,在readme里插入以下代码 ![image](https://github.com/xxxx.jpg) 2.代码高亮: ```java //这里放你的代码 ``` 另有懒人法: 在博客编辑器里编辑你的readme,然后点html,把这些html代码复制到readme也可.

github readme.md 添加图片

简要: 将图片放在仓库里面,在文件里链接它,最后 push 到 github 上. github 图片链接格式: (http://github.com/yourname/your-repository/raw/master/images-folder/xxx.png) 其实右击查看图片链接 , 就可以看到这个图片的

conding.net或github,readme.md添加图片

原因:    将图片放在仓库里面,在文件里链接它,最后 push 到 github 上.github 图片链接格式:(http://github.com/yourname/your-repository/raw/master/images-folder/xxx.png) coding 图片链接格式:(https://coding.net/u/yourname/p/your-repository/git/blob/master/images-folder/xxx.png) 要自己设定的:yourn

GitHub上README.md教程

转自:http://blog.csdn.net/kaitiren/article/details/38513715#t0 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们. README文件后缀名为md.md是markdown的缩写,markdown是一种编辑博客的语言.用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮.不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Githu

Markdown语法学习(Github/git.oschina.net上README.md书写规范)(转)

晚上在更新git.oschina.net项目时,突然想知道README.md后缀的来源,于是搜了下,发现README.md使用了一种小标记语言Markdown的语法,于是简单的看了一个,特转载如下,为了下次参考方便(http://blog.csdn.net/kaitiren/article/details/38513715也不错).中文参考手册可以参考http://wowubuntu.com/markdown/index.html Markdown 的目标是实现「易读易写」,兼容HTML. 但是

关于github中的README.md文件

0x01 README.md文件是用Markdown语言编写的,md=Markdown; 在线编辑工具: https://stackedit.io/editor# https://maxiang.io/#笔记本和标签 关于使用语法的说明: https://github.com/guoyunsky/Markdown-Chinese-Demo 0x02 Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,

原来Github上的README.md文件这么有意思——Markdown语言详解

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