如何在Github上用Markdown寫好ReadMe


MarkDown的基本語法(可以直接復制下述內容到github的readme.md顯示結果)

一、標題寫法:
第一種方法:
1、在文本下面加上 等於號 = ,那么上方的文本就變成了大標題。等於號的個數無限制,但一定要大於0個哦。。
2、在文本下面加上 下划線 - ,那么上方的文本就變成了中標題,同樣的 下划線個數無限制。
3、要想輸入=號,上面有文本而不讓其轉化為大標題,則需要在兩者之間加一個空行。
另一種方法:(推薦這種方法;注意⚠️中間需要有一個空格)
關於標題還有等級表示法,分為六個等級,顯示的文本大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #,二級標題有兩個# ,以此類推。
例如:
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
二、編輯基本語法
1、字體格式強調
我們可以使用下面的方式給我們的文本添加強調的效果
*強調* (示例:斜體)
_強調_ (示例:斜體)
**加重強調** (示例:粗體)
__加重強調__ (示例:粗體)
***特別強調*** (示例:粗斜體)
___特別強調___ (示例:粗斜體)
2、代碼
`<hello world>`
3、代碼塊高亮
```
@Override
protected void onDestroy() {
EventBus.getDefault().unregister(this);
super.onDestroy();
}
```
4、表格 (建議在表格前空一行,否則可能影響表格無法顯示)

表頭 | 表頭 | 表頭
---- | ----- | ------
單元格內容 | 單元格內容 | 單元格內容
單元格內容 | 單元格內容 | 單元格內容

5、其他引用
圖片
![圖片名稱](https://www.baidu.com/img/bd_logo1.png)
鏈接
[鏈接名稱](https://www.baidu.com/)
6、列表
1. 項目1
2. 項目2
3. 項目3
* 項目1 (一個*號會顯示為一個黑點,注意⚠️有空格,否則直接顯示為*項目1)
* 項目2

7、換行(建議直接在前一行后面補兩個空格)
直接回車不能換行,
可以在上一行文本后面補兩個空格,
這樣下一行的文本就換行了。
或者就是在兩行文本直接加一個空行。
也能實現換行效果,不過這個行間距有點大。

8、引用
> 第一行引用文字
> 第二行引用文字

頁內跳轉

Markdown會自動給每一個h1~h6標題生成一個錨,其id就是標題內容。目錄樹中的每一項都是一個跳轉鏈接,點擊后就會跳轉到其對應的錨點(即標題所在位置)。你可以點擊本文檔開始處的目錄樹嘗試一下。

如果需要在目錄樹之外還要增加跳轉到某個標題的鏈接,則有兩種辦法可以做到:
1. 使用Markdown的語法來增加跳轉鏈接:“[名稱](#id)”。
2. 使用HTML語法來增加跳轉鏈接:“<a href=”#id”>名稱

其中的“名稱”可以隨便填寫,“id”需要填寫跳轉到的標題的內容。Markdown中Id必須是小寫,且不允許空格,空格用橫線'-'代替

 

 在markdown中如何加入上標、下標?

其實了解原理后很簡單。Markdown一個套兼容HTML的語法,所以使用HTML中下標下標的語法即可。
Markdown Language is a superset of HTML, so you can use html tag sub,sup to achieve this.
寫法
H<sub>2</sub>O  CO<sub>2</sub>
爆米<sup>TM</sup>

效果

$$H_2O\ CO_2$$

$$爆米^{TM}$$

 

參考博客

1. https://blog.csdn.net/tearsky253/article/details/78968221

2. https://blog.csdn.net/qq_31796651/article/details/80803599

3. https://www.jianshu.com/p/13b3366f0260


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM