如何優雅的書寫介面文件?學會Markdown就夠了

2021-08-30 10:49:30 字數 2885 閱讀 3984

markdown 是一種「電子郵件」風格的「標記語言」,我們強烈推薦所有寫作者學習和掌握該語言。為什麼?可以參考:

在此,我們總結 markdown 的優點如下:

當然,我們既然如此推崇 markdown ,也必定會教會你使用 markdown ,這也是本文的目的所在。不過,雖然 markdown 的語法已經足夠簡單,但是現有的 markdown 語法說明更多的是寫給 web 從業者看的,對於很多寫作者來說,學習起來效率很低,現在,我們特地為寫作者量身定做本指南,從寫作者的實際需求出發,介紹寫作者真正實用的常用格式,深入淺出、**並茂地讓您迅速掌握 markdown 語法。

此時,您的介面應當如下圖所示,左側為編輯區域,右側為預覽區域,您在左側輸入 markdown 語法的文字,右側會立即幫您呈現最終結果,好了,讓我們開始學習吧~

而在 markdown 中,你只需要在文字前面加上#即可,同理、你還可以增加二級標題、**標題、四級標題、五級標題和六級標題,總共六級,只需要增加#即可,標題字型大小相應降低。例如:

# 一級標題

## 二級標題

### **標題

#### 四級標題

##### 五級標題

###### 六級標題

注:#和「一級標題」之間建議保留乙個字元的空格,這是最標準的 markdown 寫法。

一級標題至六級標題

列**式也很常用,在 markdown 中,你只需要在文字前面加上-就可以了,例如:

- 文字1

- 文字2

- 文字3

如果你希望有序列表,

也可以在文字前面加上1.2.3.就可以了,例如:

1. 文字1

2. 文字2

3. 文字3

注:-1.和文字之間要保留乙個字元的空格。

列表案例截圖如下:

在我們寫作的時候經常需要引用他人的文字,這個時候引用這個格式就很有必要了,在 markdown 中,你只需要在你希望引用的文字前面加上>就好了,例如:

注:>和文字之間要保留乙個字元的空格。

最終顯示的就是:

引用的案例截圖:

markdown 的粗體和斜體也非常簡單,用兩個*包含一段文字就是粗體的語法,用乙個*包含一段文字就是斜體的語法。例如:

粗體和斜體的案例截圖:

需要引用**時,如果引用的語句只有一段,不分行,可以用 ` 將語句包起來。

如果引用的語句為多行,可以將```置於這段**的首行和末行。

**引用的案例截圖:

顯示效果:

tables

arecool

col 3 is

right-aligned

$1600

col 2 is

centered

$12zebra stripes

are neat

$1

dog | bird | cat

----|------|----

foo | foo | foo

bar | bar | bar

baz | baz | baz

顯示效果:

dogbird

catfoo

foofoo

barbar

barbaz

bazbaz

![1]

[1]:

**如下:

![1]

[1]:

強烈建議您現在就立馬用 markdown 寫一篇文章吧,體會一下 markdown 的優雅之處!

Android中如何優雅的顯示載入介面

github位址 gradle 專案gradle中 allprojects 模組gradle中 implementation com.github.goodluck028 showloading 1.0.3 使用方法 activity loadingshow.with mainactivity.th...

如何優雅的管理APP多個介面版本

直接在controllers資料夾下增加對應版本號的資料夾,然後將controller檔案放到對應的資料夾下。訪問形式 http com v1 mobile controller v1 mobilecontroller.php showcontroller.php controller v2 mob...

如何優雅的定義 App 的介面設計

使用者體驗設計的概念非常廣泛,包含了使用者 挖掘使用者潛在動機和實用性 視覺沒感體驗等等,通俗來講,如何讓你乙個產品給使用者很爽的感覺,其中包含的知識和方法都是使用者體驗的一部分。1,擬定你的設計範圍 2,整理你的資訊架構 3,考慮資訊的不同狀態 4,考慮資訊的多樣性 5,考慮產品的視覺美感 下面還...