Gitee中 README.md文件的编辑和使用
<p>最近对它的<strong><em>README.md</em></strong>文件颇为感兴趣。便写下这贴，帮助更多的还不会编写README文件的同学们</p><p>该文件用来测试和展示书写README的各种markdown语法。</p>
<h2><strong>开始编辑README</strong></h2>
<p>当没有<strong>README</strong>文件的时候我们可以添加一个<strong>README.me</strong>文件<strong><br><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210104622455-971950377.png"></strong></p>
<p> </p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210104900861-2029687041.png"></p>
<h2>关于标题</h2>
<p>规范的<strong>README</strong>文件开头都写上一个标题，这被称为大标题</p>
<p>比大标题低一级的是中标题，也就是显示出来比大标题小点。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">大标题
===</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210110431208-670404945.png"></p>
<p>在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。</p>
<p>比大标题低一级的是中标题，也就是显示出来比大标题小点</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">中标题
-------</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210110552511-1658077012.png"></p>
<p>在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。</p>
<p>除此之外，你也会发现大，中标题下面都有一条横线，没错这就是 = 和 - 的显示结果。</p>
<p>如果你只输入了等于号=，但其上方无文字，那么就只会显示一条直线。如果上方有了文字，但你又只想显示一条横线，而不想把上方的文字转义成大标题的话，那么你就要在等于号=和文字直接补一个空行。</p>
<p><em>补空行：是很常用的用法，当你不想上下两个不同的布局方式交错到一起的时候，就要在两种布局之间补一个空行。</em></p>
<p>如果你只输入了短横线（减号）-，其上方无文字，那么要显示直线，必须要写三个减号以上。不过与等于号的显示效果不同，它显示出来时虚线而不是实线。同减号作用相同的还有星号*和下划线_，同样的这两者符号也要写三个以上才能显示一条虚横线。</p>
<p> </p>
<p>除此以外，关于标题还有等级表示法，分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;"># 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题</pre>
</div>
<p>效果如图：</p>
<p> <img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210112606645-526710700.png"></p>
<p>实际上，前文所述的大标题和中标题是分别和一级标题和二级标题对应的。即大标题大小和一级标题相同，中标题大小和二级标题相同</p>
<h2><strong>插入符号</strong></h2>
<h3><strong>圆点符</strong></h3>
<p>圆点符的语法在READM里* 后面要有一个空格。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">* 这是一个圆点
* 这是另一个圆点
* 这还是一个圆点</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210112506293-441186401.png"></p>
<p> 此外还有二级圆点和三级圆点。就是多加一个Tab。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">* 这是一个圆点
* 这是另一个圆点
* 这还是一个圆点</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210112449369-1065158806.png"></p>
<p> 如果你觉得三级的结构还不够表达清楚的话，我们可以试着换一种形式，请看<em>字符包围</em></p>
<h2><strong>缩进</strong></h2>
<p>缩进的含义是很容易理解的。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">>数据结构
>>树
>>>二叉树
>>>>平衡二叉树
>>>>>满二叉树</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210114119045-453018329.png"></p>
<p> </p>
<p> 当然比这个更一般的用法是这样。常常能在书籍里面看到的效果，比如引用别人的文章。直接看效果</p>
<h2>显示文本</h2>
<h3>普通文本</h3>
<p>直接输入的文字就是普通文本。需要注意的是要换行的时候不能直接通过回车来换行，需要使用<br>(或者<br/>)。也就是html里面的标签。<em>事实上，markdown支持一些html标签，你可以试试。</em>当然如果你完全使用html来写的话，就丧失意义了，毕竟markdown并非专门做前端的，然而仅实现一般效果的话，它会比html写起来要简洁得多得多啦。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">这是一段普通的文本，
直接回车不能换行，<br>
要使用\<br>
</pre>
</div>
<p>注意第三行的<br>前加了反斜杠 \ 。目的就是像其他语言那样实现转义，也就是 < 的转义。</p>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220094746713-1762360124.png"></p>
<p> </p>
<p> </p>
<p> </p>
<p>此外，要显示一个<em>超链接</em>的话，就直接输入这个链接的URL就好了。显示出来会自动变成可链接的形式的。</p>
<p><strong>显示空格的小Tip</strong></p>
<div>
<div>默认的文本行首空格都会被忽略的，但是如果你想用空格来排一下版的话怎么办呢，有个小技巧，那就是把你的输入法由半角改成全角就OK啦。</div>
<h3>单行文本</h3>
<p>使用一个Tab符实现单行文本。</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;"> Hello,大家好，我是果冻虾仁。
</pre>
</div>
<p>注意前面有一个Tab。在GitHub上单行文本显示效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220095211051-1817727858.png"></p>
<h3>多行文本</h3>
<p>多行文本和单行文本异曲同工，只要在每行行首加一个Tab</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;"> 欢迎到访
很高兴见到您
祝您，早上好，中午好，下午好，晚安
</pre>
</div>
<p> 效果如图：</p>
<p> <img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220095417428-1629825548.png"></p>
<h3>部分文字的高亮</h3>
<p>如果你想使一段话中部分文字高亮显示，来起到突出强调的作用，那么可以把它用 ` ` 包围起来。注意这不是单引号，而是Tab上方，数字1左边的按键（注意使用英文输入法）。</p>
<p> </p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">Thank `You` . Please `Call` Me `Coder`</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220095745360-769870266.png"></p>
<h3>模块高亮</h3>
<p>开头和结尾用```抱起来就可以实现<strong>模块高亮</strong>，里面的内容不需要<strong><br></strong>就可以换行</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">```
hello world
美好的一天
```</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220101553446-1407048336.png"></p>
<h3>文本超链接</h3>
<p>给一段文字加入超链接的格式是这样的 [ 要显示的文字](链接的地址 "悬停显示")。<strong>比如：</strong></p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">[我的博客](https://www.cnblogs.com/IT-Ramon/ "糯米雪梨")</pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191220100053037-196434957.png"></p>
<p>悬停显示注意这里是英文双引号，如果不需要悬停显示可以去除后面双引号部分的文本。</p>
</div>
<h2>插入图片</h2>
<p>网上有很多<strong>README</strong>插入图片的教程了，经我自己多次测试呢，发现可以使用的最简单，最基本的语法是：</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">// <br></pre>
</div>
<p>效果如图：</p>
<p><img src="https://img2018.cnblogs.com/i-beta/1893524/201912/1893524-20191210120010329-324781729.png"></p>
<p>添加图片超链接</p>
<div class="cnblogs_Highlighter">
<pre class="brush:csharp;gutter:true;">//](url)
[](https://www.cnblogs.com/)</pre>
</div>
<p>效果和之前一样只是点击的时候可以跳转到指定的地址</p><br><br>
来源：https://www.cnblogs.com/IT-Ramon/p/12015607.html
頁:
[1]