问在github.com上使用README.md

EN

这个有问题的标记恰好被称为Markdown，由The Daring Fireball blog的作者John Gruber创建。Markdown的原始源代码可以在Daring Fireball - Markdown上找到。

有许多Markdown方言，可以在Github Flavored Markdown页面上找到Github的文档。

来自那个页面的很好的提示：

在任何带有Markdown编辑器的Github页面上按M即可显示小抄。

您还可以使用Github Markdown Live Preview页来测试Markdown文档。

Markdown更新2012-11-08：正在努力标准化语法。参见The Future of Markdown - Jeff Atwood, Coding Horror和W3C Markdown Community Group。

更新2014-09-09：CommonMark发布了一个降价标准和规范。

(带有一些编辑的Re-posting this answer。)

有点晚了，但我用Python写了一个小的CLI。它被称为Grip (Github Readme Instant Preview)。加上Patrick的回答，这将允许您“在我的浏览器中本地查看我的文档”。

使用以下命令进行安装：

$ pip install grip

要使用它，很简单：

$ grip

然后访问localhost:5000，查看该位置的readme.md文件。

您还可以指定自己的文件：

$ grip CHANGES.md

并更改端口：

$ grip 8080

或者结合使用前两种方法：

$ grip CHANGES.md 8080

您甚至可以呈现GitHub风格的Markdown (即如何呈现评论和问题)，可选地使用repo上下文自动超链接到其他问题的引用：

$ grip --gfm --context=username/repo issue.md

为简洁起见，请使用CLI帮助查看其余选项及其详细信息：

$ grip -h

值得注意的特性：

• 可呈现与GitHub
• Fenced blocks
• Python
• 上完全相同的页面
• 在链接文件之间导航
• 将呈现的文档导出到文件

希望这能有所帮助。Check it out。

这里有一个很好的在线/实时编辑器：

http://jbt.github.io/markdown-editor/

在GitHub上也有一个Preview按钮。

在下面的屏幕截图中，当我单击“在README.md上编辑”时，会出现此按钮。

​

​

我的意思是，现在的editor比GitHub上现有的要好。

更新

刚才我在搜索Markdown和Visual Studio后发现，如果你正在使用VS，你可以在Visual Studio中安装Web Essentials并拥有Markdown支持。这很酷！

它有：

• 语法突出显示用于Markdown syntax
• Intellisense => embedded languages (W00T)的完全彩色化=> GitHub的嵌入式语言功能完全支持`语言语法。

​

​

• 预览窗口=>查看呈现的HTML的并排预览窗口
• 编译为HTML =>右键单击任意标记文件，然后选择编译标记为HTML。这将生成一个嵌套在Markdown文件下的.html文件，并且它将与Markdown文件changes.
• Custom样式表保持同步。您可以添加特定于解决方案的样式表来控制预览窗口的样式。

关于它的详细信息，here。