其他語言閱讀：English, हिन्दी, Russian
用戶在繼續之前應閱讀的重要信息，GitHub 上的項目描述語言 降價標記放置在文件“README.md”中
該術語至少可以追溯到 1970 年代，當時信息性紙質筆記被堆疊起來。 打孔卡“讀我！”在它們上面潦草描述它們的用途。可能標題為 README 可能是對劉易斯卡羅爾的愛麗絲夢遊仙境的一個有趣的推動，其中有一種藥水和蛋糕 分別標有“DRINK ME”和“EAT ME”。
以大寫字母顯示的 README 模式在整個歷史中都是一致的方面。 除了使用大寫字母的視覺表現力外，UNIX 系統將大寫字母排序在 用小寫字母，方便地將 README 放在目錄的其餘內容之前。
- 水平線
- 標題
- 文字
- 3.1。純文本
- 3.2。一行文字
- 3.3。多行文字
- 3.4。文本選擇
- 3.5。換行
- 3.6。斜體
- 3.7。脂肪
- 3.8。刪除線
- 插入表格
- 列表
- 5.1。標記
- 5.2。編號
- 鏈接
- 6.1。文本超鏈接
- 6.2。圖片鏈接
- 有用鏈接
- 7.1。盾牌
- 7.2。表情符號
- 隱藏菜單
可以通過三種方式獲得水平線（分隔線）：
- **（使用三個連續的''（星號））、
- ---（使用三個連續的'-'（破折號））、
- __（使用三個連續的 '' 字符（下劃線））
它們都顯示水平線效果
標題（字體）大小可以為 6 級，取決於行首的 #（磅）字符數。
# 一級標題
##二級標題
### 三級標題
#### 四級標題
##### 5 級標題
###### 6 級標題
##二級標題
也可以使用放置一個或多個“=”字符來創建第一級標題 標題後面的行：
標題 1
=
也可以使用放置一個或多個“-”字符來創建二級標題 標題後面的行：
標題 2
-
這裡顯示的是通常的文本，沒有任何操作。
一行文字
在行首添加 4 個空格，您的文本將在單獨的窗口中突出顯示，如示例所示。有時它適用於 標籤，但並非總是如此......製表符有時縮進 3 個或更多空格。
這裡躺著一個大學生；
他的命運是可以商量的。
隨身攜帶藥物：
愛的病被治癒了！
在每行的開頭添加 4 個空格，您的文本將在單獨的窗口中突出顯示，如示例中所示。
上述示例將無法在每一行保留複雜文本的縮進，為此目的在 三個反引號“```”，它們必須分別在文本之前和之後的不同行上。
“不為成功而奮鬥，而是為它所賦予的價值而奮鬥。”
艾爾伯特愛因斯坦
如果您只使用一對反引號，那麼您的文本將突出顯示，但不會縮進。同樣的方法 您可以突出顯示文本中的單個單詞。
生活就是在你制定計劃時發生在你身上的事情。 約翰列儂
“邏輯”可以帶你從A點到B點，“想像力”可以帶你到任何地方。 （艾爾伯特愛因斯坦）
但這還不是全部，我們經常覺得需要放置代碼片段，不僅要保留縮進， 還要用顏色突出顯示，為此您需要在前三個引號後指定編程語言
從 django.contrib 導入管理員
# 管理員設置
# 在此處註冊您的模型。
從 .models 導入 Phonenumber、Division、MilitaryUnit
class PhonenumberAdmin(admin.ModelAdmin): # 描述管理面板的目錄部分
# 指定顯示的字段
列表顯示 = (
'ID'，
'military_unit', # 從 MilitaryUnit 表中指定軍事單位
'division', # 從 Division 表中指定分割
'細分'，
)
也許這不平常也不熟悉，但是當您按下“Enter”按鈕時，您的文字仍然會顯示在一個 行，為了讓您的轉移工作，您需要在行尾添加兩個空格
或者只是添加一個空字符串，即按“Enter”兩次。這種情況下，會達到轉移效果，但是 行間距會更大。
將文本放在兩個字符“*”（星號）或“”（下劃線）之間，它將變成 斜體文字或_斜體文字
*斜體文字*或_斜體文字_
將文本放在兩個雙“*”（星號）或“_”（下劃線）字符之間，它將變成 __粗體字__或粗體字
__粗體字__或**粗體字**
三個字符“”（星號）或“_”（下劃線）之間的文本將其轉換為粗斜體文本： ___粗斜體___或粗斜體*
___粗斜體___或***粗斜體***
將文本放在兩個雙 '~' 字符之間，它將變成
刪除線文字
~~刪除線文字~~
簡單的表
|作者|安德烈·馬林琴科|
|---|---|
|職業| python-開發者|
|文章|關於自述文件中的標記|
| 作者 | 安德烈·馬林琴科 |
|---|---|
| 職業 | python-開發者 |
| 文章 | 關於自述文件中的標記 |
項目符號列表由列表的每個新行開始的字符 -、+ 或 * 組成
- 第一的
- 第二
- 第三
編號列表的創建類似於常規行編號， 1.首先 1.1。第一項 1.2.第二小段 1.3.第三小段 2. 第二 3. 第三 4.第四
我們可以從瀏覽器 https://github.com/BEPb 添加一個鏈接，它會起作用，但是如果我們想隱藏它 在文本之後，鏈接必須放在括號中，並且在鏈接之前的方括號中的文本
點擊這裡---> [tyts](https://github.com/BEPb)
點擊這裡---> tyts
如果我們在 README.md 文件中形成一個鏈接，那麼我們應該記住我們只能引用標題， 參見“標題”部分
[參見“標題”部分](#Heading)
但是如果標題由幾個單詞組成怎麼辦？...您需要將所有空格替換為“-”作為關於 水平線
[水平線](#Horizontal-line)
一切都完全一樣的感嘆號+方括號+括號的組合
如果您之前創建了一個包含您希望在 README 文件中使用的圖像的文件夾，那麼對於 顯示此類圖像，您必須在存儲庫中指定文件的相對地址，例如，在我的 media 文件夾包含一個名為 super.jfif 的圖像，顯示您需要輸入
https://shields.io/ - 如果你想添加盾牌，例如在這個文件的開頭，那麼 去站點，選擇一個盾牌，通常在gihab上輸入名稱，存儲庫的名稱並將盾牌的代碼複製到 你的自述文件。
https://github.com/BEPb/README/blob/master/emogi.md - 如果你想用表情符號裝飾你的 readmi 文件 :smiling_imp: , :innocent: 然後從你需要的對面的表中復制代碼。
</詳情>
<詳情>
複製給定的代碼並粘貼您的塊和符號
</b></詳情>
<詳情>
<summary> 隱藏文本的名稱 </summary><br><b>
這是你的隱藏文字
</b></詳情>
</詳情>