在GitHub上，很多项目都有
我猜测应该有一个编辑器或者语法解释器之类的东西。
请问在哪里可以找到介绍
README.md文件。它似乎是一种简单的格式文件，可以用于表达文本和图片。我猜测应该有一个编辑器或者语法解释器之类的东西。
请问在哪里可以找到介绍
.md文件的资料呢？18个回答
803
Markdown是一种纯文本文件格式，扩展名.md和.markdown只是以Markdown语法编写的纯文本文件。如果您的存储库中有一个Readme.md文件，在GitHub上显示的就是存储库主页上的内容。请阅读以下文档：
您可以在GitHub自身中编辑Readme.md文件。点击Readme.md，您将找到一个编辑按钮。您可以预览修改并甚至从那里提交更改。
由于它是一个文本文件，因此可以使用记事本或Notepad ++（Windows），TextEdit（Mac）或任何其他文本编辑器来编辑和修改它。存在专门的编辑器，这些编辑器在键入时自动解析Markdown并生成预览，而其他编辑器则将各种语法着色和装饰应用于显示的文本。在这两种情况下，保存的文件仍然是可读的文本文件。
如果您想创建具有实时预览的md文件，并且不想安装任何特殊的编辑器，您可以使用在线编辑器，如dillinger.io和stackedit.io。它们提供实时预览。您还可以将文件导出到Google Drive或Dropbox。
- Kien Truong
6
2在Windows上，您可能希望使用WordPad来利用格式设置以便更轻松地阅读。 - G O'Rilla
4我认为，如果你只是写小的备忘录并且不会与他人分享，应该避免使用WordPad，因为它添加到.txt文件中的内容可能会对其他编辑器（例如vim、Notepad++等）造成混乱。在处理.txt文件时最好使用纯文本，并针对非.txt文本文件如.doc和.pdf使用文字处理器或Acrobat。 - labyrinth
1我们能否在 .md 文件中添加图片或通过链接添加图片？这是可能的吗？ - Raphael
在哪些情况下应该使用这种格式？如果您打算在网页中使用其中的信息，那么可以使用它。我想将其用于简单的笔记，关于（Git）存储库并不是非常重要，但很好掌握和了解，以防万一。在这种情况下，我应该使用 .md 吗？ - carloswm85
93
如果你正在寻找一个文本编辑器的话，我建议你使用 http://dillinger.io/。它是一个简单的基于浏览器的文本编辑器，能够实时渲染Markdown格式。
然而，如果你更喜欢使用应用程序，并且你使用的是OS X操作系统，那么你可以尝试一下 Mou。它非常好用，且包含了大量的示例。
- sirLisko
6
2似乎又恢复了生机？ - GuiSim
6我建议使用 http://dillinger.io/，它是另一个非常酷的基于浏览器的文本编辑器。它还允许您链接 Dropbox、Github 和 Google Drive。 - sirLisko
这个答案中的记事本链接会触发RAR文件下载。为什么没有网页，你不是说它是基于浏览器的编辑器吗？ - evanrmurphy
该链接已失效。 - Carlos Pliego
1只是指出这不是问题的完整答案。您没有解释 .md 是什么，只是说明了如何编辑它。 - Zoe stands with Ukraine
@Zoe是正确的。 改进这个答案。 编辑器的信息只是一个附注。 - carloswm85
45
微软的Visual Studio Code文本编辑器内置了对使用Markdown语法编写的.md文件的支持。
在.md文件中，语法会自动进行颜色编码，并且可以通过按下Shift+Ctrl+V（Windows）或Shift+Cmd+V（Mac）来查看呈现出来的markdown的预览窗口。
要将它们并排显示，在编辑器右侧拖动预览选项卡，或者改用Ctrl + K V（Windows）或Cmd+K V（Mac）。
VS Code使用marked库进行解析，并默认启用Github Flavored Markdown支持，但它不会像Github的Atom文本编辑器那样在行内显示Github表情符号。
此外，VS Code支持多个Markdown插件，以实现扩展功能。
- Feckmore
1
如果您使用的是Visual Studio 2015，请参见下面的答案。 - bytedev
17
扩展名 '.md' 指的是 Markdown 文件。
如果您不想安装应用程序以阅读该格式文件，您可以在 Mac 上使用 TextEdit 或 Xcode 打开它。
在其他任何操作系统上，您都可以使用任何文本编辑器打开它，但是预计您将无法看到它的 Markdown 格式。
- codeburn
1
4实际上，您将会看到它以Markdown格式呈现。但您不会看到它的粗体、斜体、缩进和代码块等样式。 - Lightness Races in Orbit
14
没错，只需使用GitHub风格的Markdown。在您的存储库中包含README文件可以帮助其他人快速确定它是关于什么以及如何安装它。在您的存储库中包含它非常有帮助。
- esilvas
2
5被踩了。在“including one in your repository”中，“one”的意思是“任何格式的README文件”，而不仅仅是“README.md文件”。但问题是在于，该问题是在询问关于“.md”文件的普遍性，而不是关于README的普遍性。因此，这个答案与问题无关。此外，“one”的歧义性可能会让读者认为Markdown README文件一定比其他README文件更好，这是错误的。 - Rory O'Kane
1我按照之前的评论所指明的进行了更改，因为这样做很有道理，我认为它可以帮助避免混淆。然而，我不认为这是一个非常好的答案，因为它没有提供任何新的相关信息。这个问题不是关于README文件，而是关于.md扩展名。在已经有人提供了相同信息并被接受的答案六周后，没有理由再添加这个答案。 - Erick Robertson
5
Markdown是一个文本文件，它可以选择使用.md或者.markdown扩展名。它可以转换成HTML。要了解Markdown的语法，请查看GitHub Flavored Markdown。
你可以使用任何文本编辑器来编写Markdown。如果你使用的是sublime text，可以尝试使用Markdown Preview插件，它可以在浏览器中显示渲染后的Markdown内容，并且在你更改Markdown文件时自动更新。
一些在线Markdown编辑器：
- Fizer Khan
4
我建议使用 StackEdit。它是一个简单的所见即所得编辑器，可以同时使用编辑器和Markdown语法。那里有快捷的Markdown帮助语法。支持撤销/恢复、评论、GoogleDrive、Dropbox交互。
- Unicorn
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接
.markdown扩展名的好处，尽管它非常长... - endolith