哪个文件使用.md扩展名,我应该如何编辑它们?


878

在GitHub上,几个项目都有README.md文件。似乎是表达文本和图片的简单格式文件。

我猜那里有一个编辑器或语法解释。

在哪里可以找到.md文件简介?


38
我猜这是证据,它支持使用.markdown扩展名,尽管它是如此之长……
endolith 2012年

7
这里是一个链接,可以帮助您- > .MD文件扩展名
VIPIN氪。辛格

1
MarkPad是Windows中MarkDown编辑的不错的应用程序。它为您提供了编辑的预览。
skjoshi

1
用户可以尝试MarkView,这是Chrome扩展程序,用于在浏览器中编辑和查看markdown文件。
swcool 2014年

1
可以帮助您的完整指南开始于markdownblog.wax-o.com/2014/04/…。您应该尝试使用实时可视化结果的方式编写markdown(使用诸如mouapp.com之类的应用程序)。您是否知道stackoverflow发布和评论语法基于markdown?:) stackoverflow.com/editing-help
fabien

Answers:


732

Markdown是纯文本文件格式。扩展名.md.markdown仅仅是使用Markdown语法编写的文本文件。如果您的存储库中有一个Readme.md,则GitHub将在您的存储库的主页上显示内容。阅读文档:

您可以Readme.md在GitHub本身中编辑文件。单击Readme.md,您将找到一个编辑按钮。您可以预览您的更改,甚至可以从那里提交。

由于它是文本文件,因此可以使用记事本或记事本++(Windows),TextEdit(Mac)或任何其他文本编辑器进行编辑和修改。存在专门的编辑器,它们会在您键入降价标记时自动解析降价并生成预览,而其他编辑器会将各种语法颜色和修饰应用于显示的文本。但是在两种情况下,保存的文件仍然是可读的文本文件。

如果要创建md带有预览的文件,并且不想安装任何特殊的编辑器,则可以使用诸如dillinger.iostackedit.io之类的在线编辑器。他们提供实时预览。您也可以将文件导出到Google云端硬盘Dropbox


27
我发现Github的基本解释也可以作为快速入门。
Voo

2
在Windows上,您可能希望使用写字板来使用格式以便于阅读。
G O'Rilla 2014年

4
@ GO'Rilla,恕我直言,像瘟疫一样避免使用写字板,除非给自己写一些便笺,以确保您永远不会与任何人分享。它添加到.txt文件中的内容可能会对其他编辑器(vim,Notepad ++等)造成严重破坏。处理.txt时,以纯文本格式处理时要好得多,并且对于非.txt文本文件(如.doc和.pdf)使用文字处理程序或Acrobat。
迷宫

1
我们可以添加图像或通过.md文件中的链接...可以吗?
拉斐尔

1
@ user1645290是的,有可能。看到
B-GangsteR

87

如果您正在寻找编辑器,建议您使用http://dillinger.io/。这是一个基于浏览器的简单文本编辑器,可以动态渲染Markdown。

但是,如果您更喜欢某个应用程序,并且正在使用OS X,则可以尝试Mou。这是很好的例子。


2
似乎可以复活了?
GuiSim 2013年

5
我想建议http://dillinger.io/,这是另一个非常酷的基于浏览器的文本编辑器。它还允许您链接Dropbox,Github和Google驱动器。
sirLisko 2014年

此答案中的记事本链接触发RAR文件下载。为什么没有网页,您不是说它是基于浏览器的编辑器吗?
evanrmurphy 2014年

该链接不再有效
Carlos Pliego 2014年

只是指出这还不能完全解决这个问题。您无需解释.md是什么,只能解释如何对其进行编辑
Zoe


33

Microsoft的Visual Studio Code文本编辑器已内置支持以markdown语法编写的.md文件。

语法会在.md文件内部自动进行颜色编码,并且可以通过按Shift+Ctrl+V(Windows)或Shift+Cmd+V(Mac)来查看渲染的降价的预览窗口。

要并排查看它们,请将预览选项卡拖到编辑器的右侧,或者改用Ctrl+K V(Windows)或Cmd+K V(Mac)。

在此处输入图片说明

VS Code使用标记的库进行解析,并且默认情况下启用了Github Flavored Markdown支持,但不会像Github的Atom文本编辑器那样显示Github Emoji内联。

此外,VS Code支持有多个markdown插件可用于扩展功能。


如果您使用的是Visual Studio 2015,请在下面查看我的答案。
bytedev

1
注意-您可以右键单击自述文件>打开预览
Chris Halcrow,

15

扩展名“ .md ”是指Markdown文件。

如果您不想安装一个应用程序以该格式读取它们,则可以简单地使用TextEditXcode本身在Mac上将其打开。

在任何其他操作系统上,您都应该可以使用任何文本编辑器将其打开,尽管如预期的那样,您不会以Markdown格式看到它。


4
实际上,您将以 Markdown格式看到它。但是,您不会将其视为粗体,斜体,缩进和代码块。
Lightness Races in Orbit 2013年

14

是的,只有GitHub风格的Markdown。在资源库中包含README文件将帮助其他人快速确定它的含义以及如何安装它。包含在您的存储库中非常有帮助。


5
不赞成投票。“在存储库中包括一个”中的“一个”应表示“任何格式的README文件”,而不仅仅是“ README.md文件”。但是问题是,一般是在问“ .md”文件,而不是在问自述文件。因此,此答案与问题无关。而且,“一个”的歧义可能使读者认为Markdown README必须比其他README好,这是错误的。
罗里·奥肯

1
我进行了上一条注释中指定的更改,因为它是合理的,并且我认为它可以帮助避免混淆。不过,我认为这不是一个很好的答案,因为它没有添加任何相关的新内容。这个问题与自述文件无关,而与.md扩展名有关。在接受的答案提供相同的信息后六周,没有理由添加此答案。
艾里克·罗伯逊


5

Markdown只是一个文本文件,可以选择包含.md.markdown扩展名。可以将其转换为HTML。要了解Markdown的语法,请查看

GitHub风味Markdown

您可以使用任何文本编辑器进行降价。如果您是sublime text用户,则可以签出Markdown Preview插件,该插件将在浏览器中显示渲染的降价内容,并在您更改降价文件时进行更新。

一些在线降价编辑器



3

我建议StackEdit。这是简单的WISIWIG编辑器。您可以同时使用编辑器和降价语法。那里有一个快速的markdown帮助语法。撤消/重做,评论,GoogleDrive,Dropbox互连。




2

如果要为.NET解决方案创建.md文件,我建议使用Visual Studio 2015扩展Markdown编辑器,因为它具有预览面板,因此您可以实时查看更改。

编辑:这现在也应该与Visual Studio 2017一起使用。


0

如果没有阅读器,最简单的操作是使用文本编辑器打开MD文件,然后将MD文件写为HTML文件,然后双击以使用浏览器进行查看。


仅当您具有读取.md文件的插件时,此方法才有效。
布拉德·布鲁斯

0

.md代表Markdown Text。基本上,它只是另一种类型的文本文件,例如.txt

我使用Notepad ++来阅读和编辑这些内容

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.