在GitHub上,有几个项目有README。md文件。它看起来像一个简单的格式文件来表达文本和图片。

我猜在某个地方会有编辑器或语法解释。

我在哪里可以找到。md文件的介绍?


当前回答

Markdown是一种纯文本文件格式。扩展名.md和. Markdown只是用Markdown语法编写的文本文件。如果你有Readme。在你的回购中,GitHub将在你的回购的主页上显示内容。阅读文档:

标准的减价 GitHub调味Markdown

您可以编辑自述文件。md文件在GitHub本身。点击Readme。医生,你会发现一个编辑按钮。您可以预览您的更改,甚至从那里提交它们。

由于它是一个文本文件,Notepad或notepad++ (Windows), TextEdit (Mac)或任何其他文本编辑器都可以用来编辑和修改它。有专门的编辑器,在您键入标记时自动解析标记并生成预览,而其他编辑器则对显示的文本应用各种语法着色和装饰。在这两种情况下,保存的文件仍然是一个可读的文本文件。

如果你想创建一个带有预览功能的md文件,并且你不喜欢安装任何特殊的编辑器,你可以使用在线编辑器,比如dillinger。IO和stackedit.io。他们提供实时预览。您还可以导出您的文件到谷歌驱动器或Dropbox。

其他回答

是的,只是GitHub口味的Markdown。在存储库中包含一个README文件将帮助其他人快速确定它是关于什么的以及如何安装它。很有帮助,包括在你的回购。

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

微软的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 flavour Markdown支持,但它不会像Github的Atom文本编辑器那样inline显示Github Emoji。

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

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

不过,如果你更喜欢一款应用,而且你使用的是OS X,你可以试试Mou。这本书很好,而且有很多例子。

它还会在mac上显示MD。

这里有一个quicklook插件,可以在预览时显示它们。