Idea 28:Scripting(番外篇) -用工程師的方法來寫稿,Markdown語法介紹

朱騏
魔術好點子
Published in
7 min readMay 3, 2018

前言

此文章算是獨立於Scripting系列的一篇,因為我想要介紹的不是如何針對魔術文章來寫劇本,而是要單純介紹寫稿的「工具」。如果大家要寫稿、寫文章,會使用甚麼工具呢?我想不外乎就是Word、Evernote…這些文書工具,這些工具雖然都符合我們的需求,但是不知道大家有沒有遭遇過一個問題:有時調整文章格式相當麻煩。

當我們開始紀錄自己的劇本時,往往都是直接「新增空白頁」,接著把我們想到的內容,一股腦的全部打上去,等全部打完之後,在開始調整文章格式。如果對Word編輯軟體夠熟的人,這件事情不是一件麻煩事,但對於不太會使用文書軟體的人,光是調個格式可能就讓人發狂。

如果有一種編輯語法,可以讓我們使用一些標點符號,就自動產生特定格式的排版,不但讓文字編輯上可以更快速,更可以讓自己顯得很專業(?),我們可以像個「電腦工程師」一樣,寫一些簡單的符號,立刻就產生漂亮的排版效果。事實上,就連「Medium」這個部落格平台也支援需許的這種語法,例如我可以打```就產生如下效果:

只要打```就可以產生這個灰色方塊

或是只要輸入星號(*),就可以快速產生圓點的項目符號:

  • 只要輸入*號就可以產生●項目符號

當然我說的只是這個語法的其中一小塊,只要看完這篇文章,你不但會使用這種語法快速排版文字,甚至可以…(讓我先賣個關子)。

一、認識Markdown語法

今天要介紹的編輯語法叫做「Markdown」,如果你在一些檔案的結尾看到.md結尾,代表這份檔案就是使用這種語法所編輯的。Markdown在工程師的日常生活中,是非常常見的寫作語法,但是對於一般非軟體產業的人,可能就比較陌生,既然這一系列都是在講Scripting,就趁這個機會和大家分享。

根據網路上對於Markdown語法的介紹如下:

哲學Markdown的目標是用來作為一種網路內容的寫作用語言,實現「易讀易寫」的功能。因此Markdown的語法全由標點符號所組成,並經過嚴謹慎選,是為了讓它們看起來就像所要表達的意思。像是在文字兩旁加上星號,看起來就像*強調*。---摘自《Markdown文件

簡單來說,Markdown讓我們使用特定的、直覺的標點符號,達到我們在文書編輯軟體中常使用的功能,例如粗體斜體、引用…etc。

你可能會有個疑問如下:

1.Markdown是一種軟體嗎?需不需要安裝?

首先,Markdown並不是一種軟體,你可以把它想像成是一種簡單的程式語言,一種類似HTML語法的標籤語言,但是它更強調的是文件編寫的便利性。

Markdown不需要安裝,但我們的確需要使用編輯Markdown的服務介面上進行編輯,這裡跟各位介紹2個網站和軟體,可以分別根據自己的需求來選擇。

網站

在一個甚麼服務都要搬上雲端的時代,Markdown當然也不例外。這個網站可以讓我們在線上進行編輯,並且跟Google 帳號進行綁定,這樣只要有網路的地方我們都可以使用這項服務。

StackEdit的網站用起來很簡單,請參考下方圖片,最右邊就是跟Google 帳號綁定的地方(也提供其他服務的綁定);最左邊的部分就是新增文件和資料夾,使用起來非常直觀;中間的部分就是Markdown的編輯頁面,是不是看起來蠻cool的!編輯頁面在各個服務都大同小異,基本上共有三種模式:

(1)編寫模式(編輯Markdown語法的介面)

(2)編寫/瀏覽模式(可以同時進行Markdown語法編寫,同時瀏覽Markdown的效果)

(3)瀏覽模式

StackEdit畫面
  • HackMd -多人線上協作md編輯器

這個服務和前面說的StackEdit最大的不同是,它強調多人同時線上共同編輯,編輯者不用登入,只要有該份檔案的連結就可以加入編輯。這個功能在參加研習會、講座時特別方便,我曾經在《台灣資料科學年會系列活動 — 自然語言處理講座》,親眼看到厲害的工程師共同協作完一份很完整的筆記,若三五好友一起學起來,下次去研習會就可以用上了!

HackMD畫面

軟體

當然有些人還是比較喜歡下載安裝在電腦中,因此推薦使用免費的Typora,基本上使用方式和前面介紹的兩個網站很類似,只不過是離線也可使用的版本。

2.Markdown學起來很難嗎?

既然Markdown的哲學是「易讀易寫」,學習曲線可說是非常平緩,基本上只要自己試個30分鐘(或是直接用Markdown寫一篇文章),馬上就可以熟悉常用的語法。

最常被使用的語法包含了以下幾種:

  • 標題(Header)
  • 項目列表(List)
  • 風格,包含粗體、斜體…等(Styling)

如果是使用StackEdit,右邊有個「Markdown Cheat Sheet」,馬上就有小抄可以讓你看:

更完整的介紹,可以參考《Markdown文件》,但基本上我相信小抄的內容就非常夠用了。

3.Markdown有甚麼特別的功能?

如果只是單純的編輯語法,似乎也不太值得花一篇文章來介紹它,因此我想要介紹Markdown一個很實用的功能…

二、使用Markdown來畫流程圖

在Markdown語法中,支援畫製流程圖,但與其說是用「畫」的,還不如說是用「寫」來畫一個流程圖,所使用到的是「mermaid語法」。舉例來說,下方的Markdown語法可以產生流程圖:

例一```mermaid
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
```
例一
例二```mermaid  
sequenceDiagram
participant A as 觀眾A
participant B as 魔術師
participant C as 觀眾B
B->>A: 1.想看魔術嗎
A->>B: 2.不要
NOTE OVER A,B: Note:這個觀眾很難搞
B->>C: 3.想看魔術嗎
C->>B: 4.好呀
NOTE OVER B,C: NOTE:這個觀眾讚喔
```
例二

根據《mermaid》的敘述,我們可以使用Markdown來畫流程圖(FlowChart)、程序圖(Sequence Diagram)、甘特圖(Gantt Diagram)。還記得《Idea 27: Scripting(4)-Jon Amstrong:用流程圖來編寫劇本》嗎?我們可以不使用PowerPoint、Draw.io等軟體或服務,直接在寫稿的同時把流程圖一起畫完,非常的方便!

三、結語

在使用Markdown編輯完畢之後,我們可以將它輸出成HTML檔案或是PDF檔案(由於PDF檔案在StackEdit上需要贊助$5,這邊有個暗黑的方法是,直接Ctrl + P選「列印」,在列印的地方選「Adobe PDF」),這樣就是一份排版整齊的文件了。

我是朱騏,一個喜歡將專案管理知識應用在魔術學習上的魔術愛好者,如果有任何疑問、想聽的主題,歡迎留言給我 📒如果想給我一點鼓勵,請給我 1–10 個拍手;
如果覺得文章對你有幫助,請給我 10–40 個拍手;
如果有興趣看 「魔術劇本寫作」相關的分享請給我 40+ 個拍手讓我知道 👏🏻
你也可以追蹤我的粉絲團《Magic Ideas》,我會每周用「主題」的方式帶你回顧重要的魔術文章!最後,謝謝你的閱讀!

🚪所有文章傳送門:Ideas Overview

--

--

朱騏
魔術好點子

線上寫作教練,擁有 6 年的 SaaS 產品經理 & 2 年軟體技術寫手工作經驗。我專注寫 (1)技術寫作 (2)數位寫作 (3) 個人知識管理的文章 🤝 歡迎講座邀約、諮詢,可參考 www.chichu.co/training