Github怎么写README

Stella981
• 阅读 510

编辑README文件

大标题(一级标题):在文本下面加等于号,那么上方的文字就变成了大标题,等于号的个数无限制,但一定要大于0

大标题

====

中标题(二级标题):在文本下面加下划线,那么上方的文本就变成了中标题,下划线个数无限制,中标题比大标题低一级

中标题

-------

1~6级标题:文本大小依次减小,以#号开头,多少个#号就是多少级标题,#号和标题名称要并排写

#一级标题

##二级标题

###三级标题

####四级标题

#####五级标题

######六级标题

插入圆点符号:编辑的时候使用的是星号 *,星号后面要有一个空格,否则为普通星号

* 列表一

* 列表二

* 列表三

二级圆点、三级圆点:多加一个Tab,即第二行一个Tab,第三行两个Tab

* 列表一

* 列表二

*列表三

缩进:

>缩进一

>>缩进二

>>>缩进三

>>>>缩进四

>>>>>缩进五

插入链接

[百度](http://baidu.com)

插入网络图片:![](网络图片链接地址),即叹号!+方括号[]+括号(),如果不加叹号!就会变成普通文本,方括号里可以加入一些 标识性的信息

![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键上面那个,要实现语法高亮,则在```后面加上编程语言的名称

```Java

public static void main(String[] args){}

```

```javascript

document.getElementById("ts").innerHTML="Hello"

```

换行:使用标签

单行文本:前面使用两个Tab

多行文本:每行行首加两个Tab

部分文字高亮:使用``包围,这个符号不是单引号,而是Tab上方,数字1左边那个按键的符号

文字超链接格式:[要显示的文字](链接的地址"鼠标悬停显示"),在URL之后用双引号括起来一个字符串,即鼠标悬停显示的文本,可不写。

点赞
收藏
评论区
推荐文章
希望的天 希望的天
3年前
轻松搞定构造函数,new,实例对象,原型,原型链,ES6中的类
本文主要是之前我的《一文搞懂JS系列》的后续,至于为什么标题变了,因为标题字数写不下,对于JS基础感兴趣的可以看看我之前写的系列。标题变初心不变,接下来开始今天的内容。前言本文主要讲的就是函数,方法,构造函数,new操作符,实例对象,原型,原型链,ES6类。因为这几个知识点都是有互通的关系的,所以一起讲,方便大家疏通整个关于这方面
lucien-ma lucien-ma
3年前
Markdown基础语法学习
Markdown学习标题三级标题:空格标题四级标题:空格标题一级、二级以此类推(最多六级)字体样式helloworld  斜体: helloworld(注意星号和单词之间是没有空格的,下同)helloworld  加粗:  hellowor
Wesley13 Wesley13
2年前
获取标题失败~
跨站的艺术XSSFuzzing的技巧(https://my.oschina.net/u/3352375/blog/867931"跨站的艺术XSSFuzzing的技巧")对于XSS的漏洞挖掘过程,其实就是一个使用Payload不断测试和调整再测试的过程,这个过程我们把它叫做Fuzzing;同样是Fuzzing,有些人挖洞比较高效
Stella981 Stella981
2年前
Markdown语法
Markdown基本语法\TOC\优点:1、因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作。2、操作简单。比如:word编辑时标记个标题,先选中内容,再点击导航栏的标题按钮,选择几级标题。要三个步骤。而Markdown只需要在标题内容前加即可缺点:1、需要记一
Stella981 Stella981
2年前
Markdown学习教程(README
标题Headings:\标题1(对应HTML中的标签)\标题2(对应HTML中的标签)......\标题6(对应HTML中的标签)注意:标题与之间要留一个空格段落Paragraph:两段文字之间至少要留有一个空行(oneormoreblanklines)
Stella981 Stella981
2年前
GITHUB readme基本语法
一、标题写法:第一种方法:1、在文本下面加上等于号,那么上方的文本就变成了大标题。等于号的个数无限制,但一定要大于0个哦。。2、在文本下面加上下划线,那么上方的文本就变成了中标题,同样的下划线个数无限制。3、要想输入号,上面有文本而不让其转化为大标题,则需要在两者之间加一个空行。另一种方法:(推荐这种方法;注意中间需要
Stella981 Stella981
2年前
Markdown基本语法
一级标题语法:一级标题二级标题:语法:二级标题三级标题:语法:三级标题四级标题:语法:四级标题五级标题:语法:五级标题六级标题:语法:六级标题分割线:语
Wesley13 Wesley13
2年前
vimwiki使用技巧
vimwiki强大的功能便是markdown语法的使用和强大的html输出,因此,如果能够很好的使用这个插件,写一些能够在网页上显示的内容,如博客等非常强大(github上建博客对于技术人员来说很流行),那么,我们就开始把。基本vim语法如下:一级标题二级标题三级标题此次类
Wesley13 Wesley13
2年前
18 HTML标签以及属性全
基本结构标签:<HTML,表示该文件为HTML文件<HEAD,包含文件的标题,使用的脚本,样式定义等<TITLE</TITLE,包含文件的标题,标题出现在浏览器标题栏中</HEAD,<HEAD的结束标志<BODY,放置浏览器中显示信息的所有标志和属性,其中内容在浏览器中显示.
小白学大数据 小白学大数据
5个月前
python HTML文件标题解析问题的挑战
引言在网络爬虫中,HTML文件标题解析扮演着至关重要的角色。正确地解析HTML文件标题可以帮助爬虫准确地获取所需信息,但是在实际操作中,我们常常会面临一些挑战和问题。本文将探讨在Scrapy中解析HTML文件标题时可能遇到的问题,并提供解决方案。问题背景在