寫作語言

簡介

Markdown 基於 HTML，是一種轉為寫作而生的語言。

基礎語法

標題

對應 HTML 語言中的<h1>~<h6>標籤。

一級標題 #
二級標題 ##
三級標題 ###
四級標題 ####
五級標題 #####
六級標題 ######

段落

對應 HTML 語言中的<p>標籤。

段落1(文本之間空一行即為產生一個段落)

段落2(文本之間空一行即為產生一個段落)

段落2(文本之間空一行即為產生一個段落)

引言

對應 HTML 語言中的<blockquote>標籤。

> 引用的內容
> 引用的內容
> 引用的內容

有序列表

對應 HTML 語言中的<ul>和<li>標籤。

1. 文本
2. 文本
3. 文本
4. 文本

無序列表

對應 HTML 語言中的<ol>和<li>標籤。

* 文本
* 文本

- 文本
- 文本

代碼

對應 HTML 語言中的<code>標籤。

`print("Hello word!")`

代碼塊

對應 HTML 語言中的<pre>和<code>標籤。

 ```python
def sum(x, y):
	return x + y
 \```

加粗

對應 HTML 語言中的<strong>標籤。

**加粗的文字**
普通文字

傾斜

對應 HTML 語言中的<em>標籤。

*傾斜的文字*
普通文字

高亮

對應 HTML 語言中的<mark>標籤。

==高亮文本==
普通文本

刪除線

對應 HTML 語言中的<del>標籤。

~~刪除線~~

分隔線

對應 HTML 語言中的<hr>標籤。

***
---

鏈接

對應 HTML 語言中的<a>標籤。

![描述](http://example.com/)
<http://example.com/>

圖片

對應 HTML 語言中的<img>標籤。

[描述](http://example.com/example.jpg)

表格

對應 HTML 語言中的<table>、<tr>、<td>標籤。

|表標題1|表標題2|表標題3|
|------|------|-----:|
|數據1 |數據2  |數據3  |
|數據4 |數據5  |數據6  |

寫作工具

Markdown 編輯器

  1. Ulysses（僅支持 Mac 和 iOS）
  2. Typroa（支持 Mac，PC 和 Linux）

純文本編輯器

  1. Visual Studio Code（支持 Mac，PC 和 Linux）
  2. Sublimtext（支持 Mac，PC 和 Linux）

寫作規範

段落

  • 文字頂格寫，不要留空格。
  • 純文本，段落之間留一個空行，以區分段落。
  • 富文本，按照格式設定，確保不同段落文字之間在視覺上存在差異。

標點

  • 中英文混排，一律使用中文標點。
  • 中英文混排出現整句英文，英文中使用英文標點。
  • 使用直角引號「」或『』。

中文與英文、數字混排時的空格

  • 英文、數字與非標點中文文字之間有一個空格。如「XXX 說明第 1 版」，錯誤示例~~「XXX隱私政策第1版」~~。
  • 英文、數字與中文標點之間不加空格。

漢學家稱這個空格為「盤古之白」，因為它劈開了全形字和半形字之間的混沌。

另有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結婚，而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。

——vinta/pangu.js 為什麼你們就是不能加個空格呢？

引用

  • 如果在正文中部分引用第三方內容，請使用恰當的引用格式並給出出處。如：

Stay Hungry, Stay Foolish. — Whole Earth Catalog

  • 如果是全篇轉載，在全文開頭顯示位置註明出處並給出原文鏈接。如：

    本文轉載自 Wikipedia：Demark

  • 如果格式不允許超鏈接，請以文本方式直接給出原文鏈接。如：

    本文轉載自 Wikipedia - Denmark：https://en.wikipedia.org/wiki/Denmark

寫作風格

  • 簡潔
  • 準確
  • 易讀

参考资料