2011-05-07 67 views
769

在GitHub上,有幾個項目有README.md文件。它看起來像一個簡單的格式文件來表達文字和圖片。什麼文件使用.md擴展名,我應如何修改它?

我想有一個編輯器或語法的解釋。

我在哪裏可以找到.md文件的介紹?

+29

我想這是證據贊成使用'.markdown'延伸,而不是,但它是如此相當長的... – endolith 2012-05-22 19:30:33

+6

這裏是一個鏈接,可以幫助你 - > [.MD文件擴展名](http://www.fileinfo.com/extension/md) – 2012-09-21 16:39:52

+1

用戶可以嘗試[MarkView](https://chrome.google.com/webstore/detail/ markview/iaddkimmopgchbbnmfmdcophmlnghkim),一款用於在瀏覽器中編輯和查看降價文件的Chrome擴展程序。 – swcool 2014-01-20 06:48:46

回答

645

擴展.md.markdown只是使用Markdown語法編寫的文本文件。如果您的回購庫中有Readme.md,GitHub將在回購的主頁上顯示內容。閱讀文檔:

可以在GitHub上自己編輯Readme.md文件。點擊Readme.md,你會發現一個編輯按鈕。您可以預覽您的更改,甚至可以從此處提交它們。

由於它是一個文本文件,可以使用記事本(Windows),文本編輯器(Mac)或任何其他文本編輯器來編輯和修改它。存在專門的編輯器,可以在您鍵入縮減並自動生成預覽時自動解析縮減,而其他編輯則會應用各種語法着色和修飾來顯示文本。不過,在這兩種情況下,保存的文件仍然是可讀的文本文件。

如果您想要創建帶預覽的md文件,並且不想安裝任何特殊編輯器,可以使用在線編輯器,如dillinger.iostackedit.io。他們提供實時預覽。您也可以將文件導出到Google DriveDropbox

+17

我發現Github的[基本解釋](https://help.github.com/articles/markdown-basics)作爲快速介紹也非常有用。 – Voo 2014-03-28 19:03:03

+1

在Windows上,您可能需要使用寫字板來使用格式,以便於閱讀。 – 2014-11-08 16:21:02

+3

@ GO'Rilla,恕我直言,避免寫字板像瘟疫,除非寫你自己的小筆記,你永遠不會與任何人分享。它添加到.txt文件會對其他編輯器(vim,Notepad ++等)造成嚴重破壞。處理.txt時使用純文本處理效果更好,並且使用文字處理器或Acrobat處理非.txt文本文件(如.doc和.pdf)。 – labyrinth 2015-03-24 20:56:05

77

如果您正在尋找編輯,我建議您使用http://dillinger.io/。它是一個簡單的基於瀏覽器的文本編輯器,可以在運行中呈現Markdown。

但是,如果您更喜歡某個應用程序,並且您使用的是OS X,則可以嘗試Mou。這是相當不錯的例子。

+2

它似乎又重新煥發活力了? – GuiSim 2013-03-07 15:04:52

+1

牟是一個不錯的工具! – yunas 2013-07-22 10:20:06

+2

[MarkPad](http://code52.org/DownmarkerWPF/)在Window上很好地工作。 – skjoshi 2013-08-31 20:20:50

14

是的,只是GitHub flavored Markdown。將自述文件包含在存儲庫中可以幫助其他人快速確定它的含義以及如何安裝它。包含在您的回購中非常有幫助。

+5

Downvoted。通過「在你的版本庫中包含一個」中的「one」,你應該指「任何格式的自述文件」,而不僅僅是「一個README.md文件」。但問題一般是關於「.md」文件,而不是關於一般的README文件。所以這個答案與這個問題無關。此外,「one」的含糊可能會使讀者認爲Markdown自述文件必然優於其他自述文件,這是錯誤的。 – 2012-12-23 06:36:29

+1

我在前面的評論中指定了更改,因爲它是有意義的,我認爲它可以幫助避免混淆。但我認爲這不是一個很好的答案,因爲它沒有增加任何與此相關的新內容。這個問題不是關於README的,而是關於.md的擴展。在接受的答案提供了相同的信息六週後,沒有理由添加此答案。 – 2013-10-02 18:36:50

15

分機'.md'是指Markdown文件。

如果你不想安裝的應用此格式的閱讀, 你可以簡單地使用文本編輯 Xcode中本身打開它在Mac上。

在任何其他操作系統,你應該能夠使用它任何文本編輯器,雖然不如預期,你不會看到它在降價格式打開。

+4

其實,你會以Markdown格式來看它。不過,您不會將其視爲粗體,斜體,縮進和代碼塊。 – 2013-10-04 14:08:14

0

如果您沒有閱讀器,最簡單的方法是使用文本編輯器打開MD文件,然後將MD文件作爲HTML文件寫出,然後雙擊以瀏覽器查看。

+0

這隻有在您擁有讀取.md文件的插件時纔有效。 – 2013-11-06 23:25:21

5

Stack Edit是一款在線降價編輯器,可以保存到Google Drive和DropBox。

5

Markdown只是一個文本文件,可以選擇.md.markdown擴展名。它可以轉換爲HTML。要了解Markdown的語法,請查看

GitHub Flavored Markdown

您可以使用任何文本編輯器進行降價。如果您是sublime text用戶,則可以查看Markdown Preview插件,該插件將在瀏覽器中顯示呈現的降價內容,並在更改降價文件時進行更新。

一些網上降價編輯

36

GitHub的Atom text editor有降價文件live-preview mode。鍵盤快捷鍵是CTRL+SHIFT+M

它可以從編輯器使用激活的CTRL+SHIFT+M鍵綁定,目前爲.markdown.md.mkd.mkdown.ron文件啓用。

enter image description here

2

有持續的努力,以規範降價和截至目前,這很可能是來了解降價最好的地方:

http://standardmarkdown.com/

+2

現在http://commonmark.org(請參閱http://blog.codinghorror.com/standard-markdown-is-now-common-markdown) – JeffRSon 2015-09-04 10:33:33

0

的.MD代表降價文本。基本上,它只是另一種類型的文本文件,比如後綴名爲.txt

我用記事本+ +的閱讀和編輯這些

1

我建議StackEdit。這是簡單的WISIWIG編輯器。您可以同時使用編輯器和markdown語法。這裏有一個快速降價幫助語法。撤消/重做,評論,GoogleDrive,Dropbox互聯。

10

微軟的Visual Studio Code文本編輯器已內置支持以markdown語法編寫的.md文件。

語法在.md文件內部自動進行顏色編碼,並可通過按Shift+Ctrl+V(Windows)或Shift+Cmd+V(Mac)查看呈現的降價的預覽窗口。

要將它們並排查看,請將預覽選項卡拖到編輯器的右側,或使用Ctrl+K V(Windows)或Cmd+K V(Mac)代替。

enter image description here

VS代碼使用marked library解析,並具有默認啓用Github Flavored Markdown支持,但它不會顯示在Github上的表情符號內嵌像GitHub的Atom text editor一樣。

此外,VS代碼支持有幾個markdown插件可用於擴展功能。

+0

如果您使用的是Visual Studio 2015,請參閱下面的答案。 – nashwan 2016-09-21 13:34:55

1

如果您爲.NET解決方案創建.md文件,我建議您使用Visual Studio 2015擴展Markdown Editor,因爲它具有預覽面板,因此您可以實時查看所做的更改。

編輯:這也應該現在與Visual Studio 2017年工作

相關問題