寫作規範

為了讓本書的架構,能因為內容的不斷累積而變得越來越豐富,一些寫作上的基礎公約以及風格規範等,盡量彼此之間不要衝突,會讓這本書後續的維護上變得更方便。


寫作語言Markdown

首先是GitBook的寫作規範!本書是架設在Gitbook上的電子讀物,所以當然要用Gitbook喜歡的方式編輯囉!下面會介紹Gitbook最喜歡的編輯語言Markdown

Wiki百科上的介紹:

Markdown 是一種輕量級標記式語言...,它允許人們「使用易讀易寫的純文字格式編寫文件...

這邊的輕量,指的是跟其他常見的程式語言相比,例如 $$python$$、$$c$$、$$html$$。 跟其他的語言比起來,Markdown可以說是專門爲資訊時代的寫作發明的!透過簡單的語法標註,我們可以用許多方便的工具幫助我們更快速編寫我們有興趣的內容,舉凡插入圖片、註釋、插入表格、顯示程式碼、顯示數學符號與科學公式等功能,在Markdown中都是非常非常容易的。

Markdown中的文字風格

舉例來說,在Markdown中,如果是一級標題,那麼只要在句子最前方加上「#」這個符號,然後空一格,Markdown就會知道你想要的是將這個句子作為第一級標題。相信聰明的你應該已經猜到了,那如果我想要次級標題呢?沒錯,我們只要在前面再加上一個「#」井字號,就可以囉!

# 我是一級標題
## 我是二級標題

文字區塊的格式也可以作特別的宣告哦!如果想要斜體,就把想要變成斜體的字塊的前後用「_」底線包起來!像是下面這樣:

_我想當斜體_

聰明如你應該想要接著變出粗體吧!很簡單的,文字區塊的前後用「**」包起來就可以囉!

**我想當粗體**

額外小知識,如果要在Markdown中加入一行分隔線,那麼在空白一行之後使用---就可以囉!

不能說出名字的那個人

另外,如果你有想要顯示的文字,卻剛好也是Markdown語法中的形式,那麼不用擔心,只要在前面加上\反斜線,就可以避免它被Markdown讀取囉!例如下面這樣:

__就是不讓你粗體字__,其實是這樣寫的,\\就是不讓你粗體字\\,不然真的會變成粗體字啊!就是不讓你粗體字

Markdown的文字區塊種類

在Markdown中,只要沒有空行,大部分的情況他就會當作是同一個區塊。所以你想要寫第二段的時候,要記得在段落之間插入一個空行喔!

另外除了純文字之外,還有許許多多的文字區塊類型可以讓我們使用:

  1. 連結
  2. 圖片
  3. 清單
  4. 表格
  5. 標註
  6. 引用
  7. 程式碼
  8. 數學式
  9. 不想讓大家看到的害羞文字

還有其他許許多多的類型,有興趣的可以讀Markdown的說明手冊,不會太難的,麻瓜如我都可以讀懂相信在作的各位都是很聰明的。

首先介紹連結,這個簡單,它分成兩個部分,連結顯示的文字還有連結指向的地方。要顯示的文字我們用[]包住,然後要指向的網址我們用()包起來就可以了,所以如果是指向肯德基官網要怎麼作呢?

[我要吃炸雞](http://www.kfcclub.com.tw)

這樣就可以囉!注意這邊用的標點符號,不能用中文的全形符號喔!

圖片呢!就只要這樣囉

![我是屁股雞](http://static2.fjcdn.com/comments/Yesfj+is+a+much+more+intelligent+and+sophisticated+community+_fc88e4d586c873f470964fab580a9518.jpg)

我是屁股雞

其中幾個比較有趣的想先介紹給大家,第一個是標註,用法如下:

在想要事後解釋的地方打上[^1]
然後之後要記得解釋
[^1]:阿呀忘記要說什麼了

「他看起來其實話中有話,但他從不說出口1,誰知道其實只是健忘啊!」

1. 這也是無可奈何的啊!

也可以用其他的方式說例如

[^w]、[^時間]...只要記得自己宣告的時候用什麼名字,就可以事後解釋囉!

另外一個有趣的是程式碼,先來看這段python的程式碼:

from sympy import init_printing()

Markdown讓大家可以把程式語言顯示出來,不只顯示出來,還可以依照程式語言的要求,把變數highlight起來!是不是很方便呢?

具體的用法如下:

```python

from sympy import init_printing()

```

程式碼的前面後面兩行要用「```」包起來,然後前面那行後面要說你想要打的是哪個語言的程式碼!

所以如果要打matlab的程式碼,就用「```matlab」就可以囉!

fminsearch(@jump,x0,t)

另外一個常用的標註是數學公式,在Markdown中,只要前後用兩個 「$」包起來,中間的文字就會當成公式用Mathjax渲染囉!

$$x^2+y^2=2$$

最後在說明一個想要引用別人說的話的方式,只要在前面加上「>」這個符號,就可以讓古人說你想說的話囉!

引用的人名記得用
<cite>我是誰!</cite>
就可以看起來很有一回事囉!

最後引用愛因斯坦的名言跟大家說再見!

有位名人曾說2

天冷的時候還是吃麻辣鍋最棒了!好暖啊~

-- 愛因斯坦


2. 愛因斯坦1950/10/12於麻辣風暴

results matching ""

    No results matching ""