書寫README的各種markdown語法

README

該文件用來測試和展示書寫README的各種markdown語法。GitHub的markdown語法在標準的markdown語法基礎上做了擴充,稱之為GitHub Flavored Markdown。簡稱GFM,GFM在GitHub上有廣泛應用,除了README文件外,issues和wiki均支持markdown語法。


Authorbelieveszw
E-mail765846560@qq.com
Githubhttps://github.com/believeszw

目錄

  • 橫線
  • 標題
  • 文本
    • 普通文本
    • 單行文本
    • 多行文本
    • 文字高亮
    • 換行
    • 斜體
    • 粗體
    • 刪除線
  • 圖片
    • 來源于網絡的圖片
    • GitHub倉庫中的圖片
  • 鏈接
    • 文字超鏈接
      • 鏈接外部URL
      • 鏈接本倉庫里的URL
    • 錨點
    • 圖片鏈接
  • 列表
    • 無序列表
    • 有序列表
    • 復選框列表
  • 塊引用
  • 代碼高亮
  • 表格
  • 表情
  • diff語法

橫線


***、—、___可以顯示橫線效果




標題

一級標題

二級標題

三級標題

四級標題

五級標題
六級標題

文本

普通文本

這是一段普通的文本

單行文本

Hello,大家好,我是果凍蝦仁。

在一行開頭加入1個Tab或者4個空格。

文本塊

語法1

在連續幾行的文本開頭加入1個Tab或者4個空格。

歡迎到訪
很高興見到您
祝您,早上好,中午好,下午好,晚安

語法2

使用一對各三個的反引號:

歡迎到訪
我是C++碼農
你可以在知乎、CSDN、簡書搜索【果凍蝦仁】找到我

該語法也可以實現代碼高亮,見代碼高亮

文字高亮

文字高亮功能能使行內部分文字高亮,使用一對反引號。
語法:

`linux` `網絡編程` `socket` `epoll`

效果:linux 網絡編程 socket epoll

也適合做一篇文章的tag

換行

直接回車不能換行,
可以在上一行文本后面補兩個空格,
這樣下一行的文本就換行了。

或者就是在兩行文本直接加一個空行。

也能實現換行效果,不過這個行間距有點大。

斜體、粗體、刪除線

語法效果
*斜體1*斜體1
_斜體2_斜體2
**粗體1**粗體1
__粗體2__粗體2
這是一個 ~~刪除線~~這是一個 刪除線
***斜粗體1***斜粗體1
___斜粗體2___斜粗體2
***~~斜粗體刪除線1~~***斜粗體刪除線1
~~***斜粗體刪除線2***~~斜粗體刪除線2
斜體、粗體、刪除線可混合使用

圖片

基本格式:

![alt](URL title)

alt和title即對應HTML中的alt和title屬性(都可省略):

  • alt表示圖片顯示失敗時的替換文本
  • title表示鼠標懸停在圖片時的顯示文本(注意這里要加引號)

URL即圖片的url地址,如果引用本倉庫中的圖片,直接使用相對路徑就可了,如果引用其他github倉庫中的圖片要注意格式,即:倉庫地址/raw/分支名/圖片路徑,如:

https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
#語法效果
1[外鏈圖片轉存失敗(img-vEtchDOQ-1566288187751)(http://www.baidu.com/img/bdlogo.gif "百度logo")][外鏈圖片轉存失敗(img-JIUVHmnk-1566288187753)(http://www.baidu.com/img/bdlogo.gif “百度logo”)]
2![][code-past]

注意例2的寫法使用了URL標識符的形式,在鏈接一節有介紹。

在文末有code-past的定義:

[code-past]:https://img-blog.csdnimg.cn/201908060004034.png

鏈接

鏈接外部URL

#語法效果
1[我的博客](https://blog.csdn.net/believe_s "懸停顯示")我的博客

語法2由兩部分組成:

  • 第一部分使用兩個中括號,[ ]里的標識符(本例中zhihu),可以是數字,字母等的組合,標識符上下對應就行了(姑且稱之為URL標識符
  • 第二部分標記實際URL。

使用URL標識符能達到復用的目的,一般把全文所有的URL標識符統一放在文章末尾,這樣看起來比較干凈。

URL標識符是我起的名字,不知道是否準確。囧。。

鏈接本倉庫里的URL

語法效果
[README](./README.md)README

圖片鏈接

給圖片加鏈接的本質是混合圖片顯示語法和普通的鏈接語法。普通的鏈接中[ ]內部是鏈接要顯示的文本,而圖片鏈接[ ]里面則是要顯示的圖片。
直接混合兩種語法當然可以,但是十分啰嗦,為此我們可以使用URL標識符的形式。

#語法效果
1[[外鏈圖片轉存失敗(img-3jm1Qz26-1566288187754)(https://www.weibo.com/believeszw)][[外鏈圖片轉存失敗(img-pcOhbHDa-1566288187755)(https://www.weibo.com/believeszw)]
2[[外鏈圖片轉存失敗(img-7xvl2fyP-1566288187755)(/img/zhihu.png "我的知乎,歡迎關注")]][zhihu][外鏈圖片轉存失敗(img-Ne6Tj9wI-1566288187756)(/img/zhihu.png “我的知乎,歡迎關注”)]
3[![csdn-logo]][csdn]csdn-logo

因為圖片本身和鏈接本身都支持URL標識符的形式,所以圖片鏈接也可以很簡潔(見例3)。
注意,此時鼠標懸停時顯示的文字是圖片的title,而非鏈接本身的title了。

本文URL標識符都放置于文末

錨點

其實呢,每一個標題都是一個錨點,和HTML的錨點(#)類似,比如我們

語法效果
[回到頂部](#readme)回到頂部

不過要注意,標題中的英文字母都被轉化為小寫字母了。

以前GitHub對中文支持的不好,所以中文標題不能正確識別為錨點,但是現在已經沒問題啦!

列表

無序列表

語法

* 昵稱:believe_s
* 英文名:believe

效果

  • 昵稱:believe_s
  • 英文名:believe

多級無序列表

語法

* 編程語言* 腳本語言* Python

效果

  • 編程語言
    • 腳本語言
      • Python

一級有序列表

語法

就是在數字后面加一個點,再加一個空格。不過看起來起來可能不夠明顯。

面向對象的三個基本特征:1. 封裝
2. 繼承
3. 多態

效果

面向對象的三個基本特征:

  1. 封裝
  2. 繼承
  3. 多態

多級有序列表

和無序列表一樣,有序列表也有多級結構。

語法

1. 這是一級的有序列表,數字1還是11. 這是二級的有序列表,阿拉伯數字在顯示的時候變成了羅馬數字1. 這是三級的有序列表,數字在顯示的時候變成了英文字母

效果

  1. 這是一級的有序列表,數字1還是1
    1. 這是二級的有序列表,阿拉伯數字在顯示的時候變成了羅馬數字
      1. 這是三級的有序列表,數字在顯示的時候變成了英文字母

復選框列表

語法

- [x] 需求分析
- [x] 系統設計
- [x] 詳細設計
- [ ] 編碼
- [ ] 測試
- [ ] 交付

效果

  • 需求分析
  • 系統設計
  • 詳細設計
  • 編碼
  • 測試
  • 交付

您可以使用這個功能來標注某個項目各項任務的完成情況。

Tip:

在GitHub的issue中使用該語法是可以實時點擊復選框來勾選或解除勾選的,而無需修改issue原文。

塊引用

常用于引用文本

文本摘自《深入理解計算機系統》P27

令人吃驚的是,在哪種字節順序是合適的這個問題上,人們表現得非常情緒化。實際上術語“little endian”(小端)和“big endian”(大端)出自Jonathan Swift的《格利佛游記》一書,其中交戰的兩個派別無法就應該從哪一端打開一個半熟的雞蛋達成一致。因此,爭論淪為關于社會政治的爭論。只要選擇了一種規則并且始終如一的堅持,其實對于哪種字節排序的選擇都是任意的。

“端”(endian)的起源
以下是Jonathan Swift在1726年關于大小端之爭歷史的描述:
“……下面我要告訴你的是,Lilliput和Blefuscu這兩大強國在過去36個月里一直在苦戰。戰爭開始是由于以下的原因:我們大家都認為,吃雞蛋前,原始的方法是打破雞蛋較大的一端,可是當今的皇帝的祖父小時候吃雞蛋,一次按古法打雞蛋時碰巧將一個手指弄破了,因此他的父親,當時的皇帝,就下了一道敕令,命令全體臣民吃雞蛋時打破較小的一端,違令者重罰。”

塊引用有多級結構

語法

> 數據結構
>> 樹
>>> 二叉樹
>>>> 平衡二叉樹
>>>>> 滿二叉樹

效果

數據結構

二叉樹

平衡二叉樹

滿二叉樹

代碼高亮

語法

在三個反引號后面加上編程語言的名字,另起一行開始寫代碼,最后一行再加上三個反引號。

效果

public static void main(String[]args){} //Java
int main(int argc, char *argv[]) //C
echo "hello GitHub" #Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp

表格

表頭1表頭2
表格單元表格單元
表格單元表格單元
表頭1表頭2
表格單元表格單元
表格單元表格單元

對齊

表格可以指定對齊方式

左對齊居中右對齊
col 3 issome wordy text$1600
col 2 iscentered$12
zebra stripesare neat$1

混合其他語法

表格單元中的內容可以和其他大多數GFM語法配合使用,如:

使用普通文本的刪除線,斜體等效果

名字描述
HelpDisplay the help window.
CloseCloses a window

表格中嵌入圖片(鏈接)

其實前面介紹圖片顯示、圖片鏈接的時候為了清晰就是放在在表格中顯示的。

圖片描述
baidu百度

表情

Github的Markdown語法支持添加emoji表情,輸入不同的符號碼(兩個冒號包圍的字符)可以顯示出不同的表情。

比如:blush:,可以顯示?。

具體每一個表情的符號碼,可以查詢GitHub的官方網頁http://www.emoji-cheat-sheet.com。

但是這個網頁每次都打開奇慢。。所以我整理到了本repo中,大家可以直接在此查看emoji。

diff語法

版本控制的系統中都少不了diff的功能,即展示一個文件內容的增加與刪除。
GFM中可以顯示的展示diff效果。使用綠色表示新增,紅色表示刪除。

語法

其語法與代碼高亮類似,只是在三個反引號后面寫diff,
并且其內容中,可以用 +開頭表示新增,-開頭表示刪除。
另外還有有 !#的語法。

效果

+ 人閑桂花落,
- 夜靜春山空。
! 月出驚山鳥,
# 時鳴春澗中。

本文來自互聯網用戶投稿,該文觀點僅代表作者本人,不代表本站立場。本站僅提供信息存儲空間服務,不擁有所有權,不承擔相關法律責任。
如若轉載,請注明出處:http://www.pswp.cn/news/448128.shtml
繁體地址,請注明出處:http://hk.pswp.cn/news/448128.shtml
英文地址,請注明出處:http://en.pswp.cn/news/448128.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

Apache2.4配置ssl

1》驗站 如下截圖,驗站就是在DNS域名商哪里,在對應host下面,添加一個TXT記錄類型,主機記錄,記錄值后,檢測即可。   2》SSL證書申請 阿里云,騰訊云有很多免費證書申請,免費的缺點是…

助你解決新手開車四大問題 為您支招

新手開車起步技巧涉及方方面面,對于新手來說,如何首次將車獨自開上路且不發生任何意外是眾多人熱切盼望的理想方式。但是新手上路難免會磕磕碰碰,發生小摩擦都是在所難免的,那么如何在起步階段就將發生事故的概率降到最低呢?在此…

VUE - get 、post 請求后端接口:get 、post 寫法 (Axios 中文說明文檔地址)

前些天發現了一個巨牛的人工智能學習網站,通俗易懂,風趣幽默,忍不住分享一下給大家。點擊跳轉到教程。 Axios 中文使用說明文檔地址:Axiox 中文說明文檔 我只是記錄下寫法,兩種請求都能正常運行: 1. 安裝…

C++11新特性——移動語義,右值引用

移動語義 有一些類的資源是__不可共享__的,這種類型的對象可以被移動但不能被拷貝,如:IO 或 unique_ptr 庫容器、string 和 shared_ptr 支持拷貝和移動,IO 和 unique_ptr 則只能移動不能拷貝。。 右值引用 右值引用是必須綁定到…

離合器半聯動點的判斷和技巧 為您支招

現在將離合器半聯動的使用方法揭密如下:將離合器抬到車開始動時你就別再抬了,你如果感覺到車有些快了,可再往下踩些,你如果感覺到車有些慢了,可再往起抬些,這樣可將車速控制在你想要的速度范圍之內。 ● 坡…

客戶端調用 WCF 的幾種方式

轉載網絡代碼.版權歸原作者所有.....客戶端調用&#xff37;&#xff23;&#xff26;的幾種常用的方式&#xff1a;&#xff11;普通調用var factory new DataContent.ServiceReference1.CustomerServiceClient();factory.Open();List<DataContent.ServiceReference1.Cust…

VUE:組件間相互跳轉、頁面帶參跳轉

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 只是記錄下用法&#xff1a; 從 A 頁面跳轉到 B 頁面。 如下寫法&#xff1a; A 頁面跳轉方式&#xff1a; 代碼&#xff1a; getdat…

Protocol Buffer 序列化

Protobuf使用 目錄 proto3的更新定義協議格式編譯protobufprotobuf_API 枚舉和嵌套類標準消息方法解析和序列化 寫一條消息閱讀消息編譯Protobuf擴展優化高級用法 proto3的更新 在第一行非空白非注釋行&#xff0c;必須寫&#xff1a; syntax "proto3";字段規…

如何調整反光鏡和座椅的位置 為您支招

【太平洋汽車網 學車頻道】首先要進行座椅的高度調整&#xff0c;上下調整座椅讓頭部離車頂至少還有一拳的距離。如果座椅調得太高&#xff0c;車輛在顛簸時頭部容易碰到車頂&#xff0c;調得太矮了又會影響視線。然后是前后距離的調整&#xff0c;當腳踩住制動踏板至最深處時…

關于hexo與github使用過程中的問題與筆記

快速閱讀 如何用github 和hexo 創建一個blog 1.github中要新建一個與用戶名同一樣的倉庫&#xff0c; 如:homehe.github.io - 必須是io后綴。一個帳戶 只能建立一個2. 綁定域名 &#xff0c; A記錄指向ip, cname記錄指向homehe.github.io 3. 配置sshkey - 個人設置 -> SSH a…

CSS 中 的 margin、border、padding 區別 (內邊距、外邊距)

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 圖解CSS padding、margin、border屬性 W3C組織建議把所有網頁上的對像都放在一個盒(box)中&#xff0c;設計師可以通過創建定義來控制這…

CMake 常用的預定義變量

CMake 常用的預定義變量 PROJECT_NAME : 通過 project() 指定項目名稱 PROJECT_SOURCE_DIR : 工程的根目錄 PROJECT_BINARY_DIR : 執行 cmake 命令的目錄 CMAKE_CURRENT_SOURCE_DIR : 當前 CMakeList.txt 文件所在的目錄 CMAKE_CURRENT_BINARY_DIR : 編譯目錄&#xff0c;…

什么是轉向燈?使用轉向燈有何技巧?

什么是轉向燈&#xff1f;如何使用轉向燈&#xff1f;新手司機對車輛還不是很熟悉&#xff0c;如何正確使用轉向燈&#xff0c;尤其是在不同路段中該怎么正確使用轉向燈&#xff0c;成為了很多新手們的困擾之一&#xff0c;今天我們就來為大家解決這個問題吧&#xff01; 轉向燈…

基于Flask開發企業級REST API應用(一)

關于我 編程界的一名小小程序猿&#xff0c;目前在一個創業團隊任team lead&#xff0c;技術棧涉及Android、Python、Java和Go&#xff0c;這個也是我們團隊的主要技術棧。 Github&#xff1a;github.com/hylinux1024 微信公眾號&#xff1a;angrycode 前面對Python WEB框架Fla…

解決:Do not use built-in or reserved HTML elements as component id: form

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 1. vue 新寫了個組件&#xff0c;運行工程成功&#xff0c;但界面沒有出效果&#xff0c;F12 提示有一個警告&#xff1a; Do not use …

移動語義,右值引用

移動語義 目錄 右值引用變量是左值move庫函數移動構造函數和移動賦值移動操作庫容器和異常移動賦值操作符移動后的對象必須是可以析構的合成移動操作右值移動左值拷貝右值在無法被移動時進行拷貝拷貝和交換賦值操作與移動移動迭代器右值引用和成員函數右值與左值引用的成員函…

集合練習:登錄注冊功能

需求&#xff1a; 1、登錄賬號唯一&#xff0c;在注冊時驗證輸入的賬號是否可用&#xff0c;若已存在&#xff0c;則不可用&#xff0c;若不存在則可用2、登錄時使用賬號密碼進行驗證1 /**2 * author Administrator3 * 登錄信息 4 */5 public class UserLogin {6 …

vue 通信、傳值的多種方式(超詳細)

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 一、通過路由帶參數進行傳值 ①兩個組件 A和B,A組件通過query把orderId傳遞給B組件&#xff08;觸發事件可以是點擊事件、鉤子函數等&am…

新手開車 駕駛小秘訣要牢記

有很多人剛買到新車興奮異常&#xff0c;憑著并不熟練的駕駛技術&#xff0c;過了幾天的車癮后發現&#xff0c;剛買的車怎么出現了這樣那樣的問題 有很多人剛買到新車興奮異常&#xff0c;憑著并不熟練的駕駛技術&#xff0c;過了幾天的車癮后發現&#xff0c;剛買的車怎么出現…

chrome中Google插件導出導入

導出插件&#xff1a; 一般電腦默認將你安裝的插件存放的位置在&#xff1a;C:\Users&#xff08;用戶&#xff09;\你的電腦名稱\AppData\Local\Google\Chrome\User Data\Default\Extensions 這個文件夾下。這里的 AppData 是個隱藏文件夾&#xff0c;需要顯示隱藏文件夾才行…