github一個項目一個倉庫,每個倉庫中都有一個README.md文件,這個文件顯示的基本都是項目介紹用法等等。
這么多內容,而且有時候排版也挺復雜的,我第一次寫的比較簡單,就直接記事本編輯的,但要想寫的圖文並茂有意思,該怎么辦呢?
我特地去搜了下,原來README.md文件是用Markdown語言編寫的。
Markdown語言簡介:
Markdown是一種可以使用普通文本編輯器編寫的標記語言,通過簡單的標記語法,它可以使普通文本內容具有一定的格式。創始人為約翰·格魯伯(John Gruber)。
用途:
①Markdown的語法簡潔明了、學習容易,而且功能比純文本更強,因此有很多人用它寫博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown編輯器的博客平台有Ghost和Typecho。
②用於編寫說明文檔,並且以“README.MD”的文件名保存在軟件的目錄下面。
③除此之外,現在由於我們有了RStudio這樣的神級編輯器,我們還可以快速將Markdown轉化為演講PPT、Word產品文檔、LaTex論文甚至是用非常少量的代碼完成最小可用原型。在數據科學領域,Markdown已經被確立為科學研究規范,極大地推進了動態可重復性研究的歷史進程。
我喜歡用的編輯器:
sublime安裝上Markdown Editing和Markdown Preview 插件這兩款插件就可以了
第一款用來編寫Markdowm語法,第二款用來預覽導出等
語法教程:
http://wowubuntu.com/markdown/basic.html
最后打個廣告,本人創建了一個前端技術qq群399627992,有興趣的可以加一下,一起學習一起進步。