在github.com上使用README.md

我不太熟悉github在更新README文件时使用的轻量级标记语言。

我可以在哪里阅读关于如何为我的开源库的README / wiki文件编写适当的标记语法的资源?

是否有一个工具,我可以“在我的浏览器本地审查我的文档”之前推更新的自述文件到我的github存储库?

有问题的标记巧合地叫做Markdown ,由Daring Fireball博客的作者John Gruber创build。 在Daring Fireball – Markdown中可以findMarkdown的原始来源。

有许多Markdown方言,Github的文档可以在Github Flavored Markdown页面find。

从该页面的不错的提示:

按任何Github页面上的M与Markdown编辑器显示的cheatsheet。

您也可以使用Github Markdown实时预览页面testing您的Markdown文档。

更新2012年11月8日 :正在努力标准化Markdown语法。 参见Markdown的未来 – Jeff Atwood,编码恐怖和W3C Markdown社区小组 。

更新2014-09-09 : CommonMark降价标准和规格已经发布。

( 重新张贴这个答案进行一些编辑。)

有点迟到的游戏,但我写了一个Python的小CLI。 它被称为Grip(Github自述即时预览) 。 再加上帕特里克的答案,这将让你“在我的浏览器本地查看我的文档”。

安装它:

$ pip install grip 

要使用它,只需:

 $ grip 

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

你也可以指定你自己的文件:

 $ grip CHANGES.md 

并更改端口:

 $ grip 8080 

或者结合前两个:

 $ grip CHANGES.md 8080 

你甚至可以呈现GitHub-FlavoredMarkdown(即如何评论和问题呈现),可选地与回购上下文自动超链接引用其他问题:

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

为简洁起见,请使用CLI帮助查看其他选项及其详细信息:

 $ grip -h 

显着特点:

  • 将页面渲染成与GitHub完全一样
  • 围栏的块
  • Python API
  • 在链接的文件之间导航
  • 将呈现的文档导出到文件

希望这可以帮助。 检查出来 。

请注意,自2014年2月起,“ 渲染散文差异”( Rendered Prose Diff ),您还可以在降价文件中看到diff的渲染版本:

提交和提取包括散文文件在内的请求现在都具有源代码和渲染视图

TR1vY.png

非文本更改以低调虚线下划线显示。 将鼠标hover在文字上,查看发生了什么变化:

TF1rQ.png

这里有一个很好的在线/现场编辑器:

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

GitHub还有一个Previewbutton。

在下面的屏幕截图中可以看到,当点击README.md Edit时,出现这个button。

在这里输入图像说明

恕我直言,现场编辑比现有的GitHub更好。

UPDATE

刚才我在searchMarkdown和Visual Studio后发现,如果你使用VS,你可以安装Web Essentials,并且在Visual Studio中有Markdown支持。 这很酷!

它有:

  • 语法高亮=> Markdown语法的完全着色
  • embedded式语言的Intellisense( W00T )=> GitHub的embedded式语言function完全支持“`语言语法。

在这里输入图像说明

  • 预览窗口=>查看呈现的HTML的并排预览窗口
  • 编译为HTML =>右键单击任何Markdown文件,然后select将Markdown编译为HTML。 这将生成一个嵌套在Markdown文件下的.html文件,当Markdown文件更改时它将保持同步。
  • 自定义样式表=>您可以添加特定于解决scheme的样式表来控制预览窗口的样式。

关于这里的细节。

另一个select – Github的新文本编辑器Atom,将在编辑时渲染Github风格的降价。 请参阅https://atom.io/

我不确定它是否会长期免费(如啤酒)。

我没有发现其他工具已经足够好了 – 我想要:

  1. 能够离线编辑
  2. 不只是普通的降价,而是实际的Github风味降价

这是我最终解决的问题: https : //github.com/ypocat/gfms

 > gfms Github Flavored Markdown Server. Run in your project's root directory. Usage: gfms Options: -p, --port Port number to listen at. [required] -h, --host Host address to bind to. [default: "localhost"] --proxy if behind a proxy, proxy url. -a, --api Render using Github API. -n, --no-api-on-reload Disable usage of Github API when the doc is manually reloaded. 

所以我有别名:

 alias gm='gfms -a -p 8070' 

使用-p选项会触发Github API并使用实际的当前Github CSS,所以没有任何意外。

截至今天,您可以在编辑文件时进行预览。

在这里输入图像说明