最近要發表程式方面的論文,期刊要求上傳的論文中要有README.md 這個檔案,在網路爬文爬很久才大概了解README.md該如何撰寫。因此在這裡想要整理一下,提供大家更簡易上手的路!!!!!!
附檔名的.md其實就是markdown的縮寫,一般用記事本打開,看起來如就是很多的文字。
但在網站(如Github)或一些可以開.md檔案專用的程式上看起來卻不一樣,像下圖一樣。
所以寫.md的檔案是有點學問的阿,那到底要怎麼寫呢????
以下有兩個步驟:
*****第一步: 下載MarkdownPad 2*****
用MarkdownPad2 來撰寫markdown 格式的檔案非常方便,左邊程式碼寫完,右邊馬上就可以看到上傳後顯示的樣子了。
MarkDownPad 2的下載網址: http://markdownpad.com/ ,點進去就會看到以下畫面..............
點選畫面中紅色圈起來的部分,就可以下載了。注意!!!!!如果使用win10的電腦,下載後,程式右方可能無法顯示.md在網站上看的樣子,需要下載一些補丁來補救,以下網址有補丁可以下載:
https://my.oschina.net/qsmoon/blog/501697 ,看看裡面的內容應該就知道如何安裝囉,接下來要來看MarkdownPad2 如何撰寫。
*****第二步: MarkdownPad 2如何撰寫*****
首先教大家如何用標題,其實只要在文字下方加上兩個以上的減號(-)就可以弄出類似標題的格線了。
如果要將文字放大,可以在文字下方用2個以上的等於符號(=),或是文字前面用1個井號(#),大家可以自己去試試看。
1~6個#號其實都有它的功能,可以加粗文字,並且#號越多文字越小。
教到這邊,大家其實已經可以寫出一篇很有層次的.md檔了,其他功能請參閱Markdown的網站: http://markdown.tw/ ,
裡面都有詳細的說明。或是直接去網路上找一些Markdown的範例來看看。以下列出MarkdownPad2 中常用的快捷鍵。
段落引用 > Ctrl + Q
新的段落--- Ctrl + R
列表項 - Ctrl + U
有序列表項 1. 2. Ctrl + O
斜體文本CONTENT Ctrl + I
插入粗體 Ctrl + B
刪除當前行 Ctrl + D
搜索 Ctrl + F
搜索文檔 Ctrl + Alt + F
插入圖像 Ctrl + G
插入標題 Ctrl + H
插入代碼 Ctrl + K
插入超鏈接 Ctrl + L
創建新文稿 Ctrl + Alt + N
主題切換 Ctrl + Alt + J
編輯模式 Ctrl + M
閱讀模式 Ctrl + Alt + M
全屏 F11
這是參考:
https://zybuluo.com/perkyoung/note/23874所寫的內容,其中比較可能會用到的地方,我將它用紅色粗體來標示。這篇的教學到此結束,有遇到什麼問題,歡迎大家提出討論!!!
留言列表