如何创建和处理.md页面

时间:2013-01-12 20:55:13

标签: github markdown

我刚刚在github上看到自述文件页面是一种简单的方式来设置一个简单的自述文件

有谁知道我在哪里可以获得有关如何将.md转换为真正的html页面的更多信息? 是github特有的东西还是某种宝石?

readme.md

标题1

title 2

粗体文字

linke_text

3 个答案:

答案 0 :(得分:2)

Ruby工具箱中详细介绍了各种Markdown宝石,它可能是使用现有宝石的最佳和最简单的方法。

我过去曾使用过Maruku,而且工作得很好。我相信Github会为Github Pages使用另一个名为Red Carpet的gem。

例如Maruku:

doc = Maruku.new('# Title 1')
puts doc.to_html

这将输出:

<h1>Title 1</h1>

答案 1 :(得分:2)

您正在查看的格式是Markdown。 Markdown的主页位于:http://daringfireball.net/projects/markdown/

Markdown也是StackOverflow使用的标记格式。

答案 2 :(得分:2)

对于即时转换,您可以查看http://www.markdown.io/

即如果您的文件位于http://example.com/myfile.md,则只需将markdown.io放在其前面:http://markdown.io/http://example.com/myfile.md