1. 程式人生 > >GitHub上README.md常用的編寫手法

GitHub上README.md常用的編寫手法

首先注意一點,GitHub上README.md的編寫,在大多數情況下與CSDN的MarkDown編輯器一樣的,但是它回車不一樣,在README.md上用<br> 代替回車。在不需要上傳圖片等資源時,基本上只需要注意回車即可。而需要在README.md上展示圖片等資源的方法,本文也有介紹。以下給出常遇的一些情況的寫法。
效果可以看我放到github上的例子:點選此處前往

1.標題

在文字前寫#,注意文字與#之間有一個空格

# 一級標題
## 二級標題
### 三級標題

以此類推
或者用連續的減號或等號寫在文字之下:

標題
---

2.粗體斜體

**這個是粗體**
*這個是斜體* ***這個是粗體加斜體***

3.程式碼塊

因為編輯器原因,這裡上圖(就是一對三個在鍵盤上的esc鍵下的那個鍵):
這裡寫圖片描述

4.表

|列名1|列名2|
|:---|:---|
|列1的內容1|列2的內容1|
|列1的內容2|列2的內容2|

以此類推
5. 連結

[會顯示出來的描述](跳轉網址)

這裡直接給個例子吧:

[點選前往谷歌搜尋](https://www.google.com.hk/)

效果:
這裡寫圖片描述

6. 圖片

建議的做法是現將readme.md裡面要展示的圖片放到倉庫裡面,再呼叫圖片連結,當然直接呼叫網路上已經有的圖片地址是面有問題的。顯示圖片的寫法:


![這個括號裡寫的在圖片載入失敗時顯示](圖片網址)

在github網頁開啟圖片,瀏覽器顯示的網址就是圖片的地址了。
舉例:

![頭像](https://github.com/HeTingwei/ReadmeLearn/blob/master/avatar1.jpg)

效果:
這裡寫圖片描述
大得螢幕都顯示不完了,下面舉例怎麼控制圖片尺寸。

<img src="https://github.com/HeTingwei/ReadmeLearn/blob/master/avatar1.jpg" width="150" height="150" alt="圖片載入失敗時,顯示這段字"/>

效果:
這裡寫圖片描述

接著如果又想讓圖片居中:

<div align=center><img width="150" height="150" src="https://github.com/HeTingwei/ReadmeLearn/blob/master/avatar1.jpg"/></div>

效果:
這裡寫圖片描述

相關推薦

GitHubREADME.md常用編寫手法

首先注意一點,GitHub上README.md的編寫,在大多數情況下與CSDN的MarkDown編輯器一樣的,但是它回車不一樣,在README.md上用<br> 代替回車。在不需要上傳圖片等資源時,基本上只需要注意回車即可。而需要在README.md

GitHubREADME.md編寫教程

最近對它的README.md檔案頗為感興趣。便寫下這貼,幫助更多的還不會編寫README檔案的同學們。README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計式的部落

GitHubREADME.md排版樣式教程

最近對它的README.md檔案頗為感興趣。便寫下這貼,幫助更多的還不會編寫README檔案的同學們。 README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧

GitHubREADME.md的簡單介紹

1、編輯README檔案 大標題(一級標題):在文字下面加等於號,那麼上方的文字就變成了大標題,等於號的個數無限制,但一定要大於0 大標題 ==== 中標題(二級標題):在文字下面加下劃線,那麼上方的文字就變成了中標題,下劃線個數無限制,中標題比大標題低一級 中標題 -------  1

GitHubREADME.md教程

README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計式的部落格編輯方案著實讓人眼前一亮。不過GitHub支援的語法在標準markdown語法的基礎上做了修改,

GitHubREADME.md使用指南

README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計式的部落格編輯方案著實讓人眼前一亮。不過GitHub支援的語法在標準markdown語法的基礎上做了修改,稱

GitHubREADME.md檔案的圖片大小尺寸

1. GitHub的readme檔案的圖片也是可以用HTML的格式來寫,同時可以修改大小,如圖: 直接用img標籤,md檔案可以識別 2. 圖片前與文字要用“回車”隔開,不然文字和圖片會在一行展示 效果:

GitHub README.md語法

Markdown 的目標是實現「易讀易寫」,相容HTML。 但是,在 HTML 區塊標籤間的 Markdown 格式語法將不會被處理。比如,你在 HTML 區塊內使用 Markdown 樣式的強調會沒有效果。也就是說,Markdown 與HTML標籤不能巢狀使

GitHubREADME.MD 編寫

最近對它的README.md檔案頗為感興趣。便寫下這貼,幫助更多的還不會編寫README檔案的同學們。 README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計式的部落格編輯方案著實

github傳檔案和編寫.md格式檔案

一、利用git bash上傳檔案到github上和克隆檔案到本地其實我們在github中建立完倉庫就可以直接上傳檔案了第一步:第二步:第三步:我之所以用git上傳的原因是因為有的時候網路不好,這種方法上傳不上去,其實git的功能很強大,只是目前我還用不到,也有人說用這個沒辦法

gitHubreadme.md編寫語法

1.標題表示法:分為六個等級,顯示的文字大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #,二級標題有兩個# ,以此類推。注意:#與標題名中間的空格 # 一級標題 ## 二級標題 ### 三級標題 #### 四

githubREADME.md文件格式

body pda 刪除線 targe edit hello 粗體 編輯器 def 一.在線編輯器:stackedit 網址:https://stackedit.io/ README.md是使用Markdown語法。基本規則如下: Markdown 語法速查表 1 標題

README.md編寫

html innerhtml 兩個 鼠標 document git nbsp 單引號 文件夾 1、編輯README文件 大標題(一級標題):在文本下面加等於號,那麽上方的文字就變成了大標題,等於號的個數無限制,但一定要大於0 大標題 ==== 中標題(二級標題):在

githubREADME.md書寫規範

參考文件----《github中README.md書寫規範》 一、換行 e.g. 段落1段落2 二、標題 大標題 中標題 #一級標題 ##二級標題 ###三級標題 ####四級標題 #####五級標題 ######六級標題 三、區塊 >區塊1 >>區塊2 >

GitHub編輯README.md檔案

一,標題; 格式:# 標題 #個數越少,標題級別越高; 二,程式碼塊; 格式: ```所用語言 程式碼 ``` 例: 效果: 三,連結; 格式:[標題](目標連結 "懸停顯示")

GitHubREADME.md基本語法

Github中README.md基本語法 參考連結: 部落格 推薦的幾款編輯器: Mac下離線編輯器: Mou Markdown基本語法 md,是Markdown的縮寫,下面簡單介紹Markdown語法: 一、標題寫法: 第一種方法: 1、在文

【轉】githubREADME.md中程式碼高亮、加入表格等解決方法

【原文】http://blog.csdn.net/guodongxiaren/article/details/23690801 本文解決了往github的readme檔案中換行、插圖、加url連結的問題,寫的相當詳細。 (新增:字型變紅 <font color=

GitHubREADME寫法暨GFM語法解讀

轉載請保留原作者guodongxiaren的原文地址: 本文在GitHub的演示地址: -------------------------------------------------------------------- 自從開始玩GitHub以來,就越來越感覺它有

Github 工程README.md 新增圖片

1、工程提交時,把png、jpg等圖片一起隨工程上傳。上傳後在github點選那個工程,找到圖片,然後點選會在視窗顯示圖片;這時候把瀏覽器位址列複製一下,一般這個圖片連結如下格式:      https://github.com/ljheee/HexTransform/bl

GitHubREADME.md檔案的編輯和使用

最近對它的README.md檔案頗為感興趣。便寫下這貼,幫助更多的還不會編寫README檔案的同學們。 README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計