编辑GitHub的Readme.md的最好方法是什么？

编辑GitHub的Readme.md的最好方法是什么？

我发现自己正在编辑自述文件，然后推送，看到错误或格式错误，再次编辑它，然后按下它…

它确实在提交历史上做了一个数字。

有没有更好的办法？ 或者我不应该关心提交历史，只要在Readme上阅读香蕉。

也许我甚至不应该使用自述文件，而是使用GH页面 ？

---

在提交给github之前，如何testing我的readme.md文件的外观？ – 刚刚发现了类似的问题，但上面有更详细的问题。

Answer 1

我只是编辑github上的自述文件作为原始文件。 您可以在提交更改之前查看预览。

Answer 2

http://prose.io是一个伟大的工具！; 它在github页面上托pipe，是一个完全通过github API工作的无数据库应用程序。 如果你碰巧有一个GitHub Jekyll网站，那么编辑器体验就有一些很好的特性。

嘿，它是开源的！ http://github.com/prose/prose

Answer 3

我使用的是Atom ，它是Github的文本编辑器

您可以并排即时预览。 您不必切换应用程序或执行任何其他命令。

预览快捷键是Ctrl + Shift + m ，或者你可以查看下面的图片。

Answer 4

我build议在线编辑器stackit 。 你不需要安装任何东西。

另外，它支持将文件拖放到编辑器中。

此外，它支持在线更改视图，什么使它更强大！

此外，您可以保存，发布，共享或下载文件。

Answer 5

一旦你知道如何格式化 ，你可以尽量减less提交，除非你没有拼写错误:)

您可以使用以下任何标记：

• .markdown（Redcarpet）
  • gem install redcarpet
• 。纺织品
  • gem install RedCloth
• .rdoc
  • gem install rdoc -v 3.6.1
• .ORG
  • gem install org-ruby
• .creole
  • gem install creole
• .mediawiki
  • gem install wikicloth
• .rst
  • easy_install docutils
• .asciidoc
  • brew install asciidoc
• 。荚
  • Pod::Simple::HTML自带Perl> = 5.10。
  • 来自CPAN的Pod :: Simple应该安装在较低的版本上。
• 。文本
  • 如果你不关心格式化，纯文本也可以正常工作

Answer 6

我使用http://dillinger.io/ 。 复制并粘贴README.md文件的内容，进行编辑并将其恢复。 我遇到的最好的降价编辑器。

Answer 7

关于自述文件和GH页面，请记住，自述文件应该是这样的：一个自述文件，作为一个有用的信息起点（安装说明，项目页面的链接等）存档您的项目的副本。 假设我以最终用户的身份下载你的项目。 我提取档案。 我现在需要知道什么？ 这是自述文件中必须包含的内容。

如果您使用自述文件作为您项目信息的前往位置， 因为 GitHub在项目页面上显示得如此突出，您绝对应该考虑使用GH页面。

Answer 8

有点晚了，但我写了一个Python的小CLI来做到这一点。 它被称为Grip（Github自述即时预览） 。

GitHub上的预览很适合做小编辑，但是我个人觉得自己花了很多时间编辑自述文件。 正如@Zorayr所指出的那样，你需要小心GitHub的预览，更糟糕的是，你现在不能暂时保存新的散文，以后编辑/重写，而不需要实际提交你的草稿。 这是你的git历史上比必要的更多的噪音。

握紧，所有的改变都是本地的，直到你准备好了。 你可以使用你最熟悉的编辑器。

安装它：

 $ 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 

其他显着特点：

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

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

（注意：这是对这个答案的重新发布，只是对上下文进行了一些编辑。）

Answer 9

有一个Sublime插件 ，允许您在浏览器中预览您的降价，Github或普通降价。 很容易使用，它有键盘快捷键。 我在崇高的文字3中使用它。

Answer 10

对于mac有一个很好的免费工具http://mouapp.com/ 。 您可以在单独的窗口中实时预览您的代码。

Answer 11

只需通过Github网站进入Github库，然后点击README.md文件即可。

你会在屏幕右边的“Raw，Blame，History …”和一个带有铅笔图标的“编辑”button上有一些button。

点击它，现在你有一个编辑器，让你写一些减价和更新/预览您的自述文件。

Answer 12

Github上的一个人在3个月前发布了这个版本。 也许他读了这篇文章。 https://github.com/gedex/preview-github-readme.md

这是一个PHP文件，你只需指向该url，并添加您的文件作为参数即

 http://localhost/preview_github_readme.php?file=/path/to/readme.md 

它会对付他们的API。

还有一个好的git仓库可以做类似的事情，但只是使用html和javascript。 https://github.com/dzello/preview_markdown_locally我相信第一个应该更准确。; 我也喜欢在他们的网站上使用编辑器。 +1给Matt Esch

Answer 13

我使用这个在线编辑器stackedit.io 。 这十分完美

Answer 14

我发现Dillinger.io有助于使用在线编辑器编辑README.md文件。

Answer 15

我使用括号 。 之后，我安装Markdown预览扩展，使我能够实时查看.md的最终版本。 很有用。

Answer 16

使用这个备忘单来帮助你在https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

两种方式：

1. 转到您的repo并单击readme.md并select编辑选项。 所以你可以使用备忘单在线编辑它。

2. 转到您使用备忘单进行克隆和编辑的本地回购。

但我build议去在线编辑，你可以看到现场预览:)

Answer 17

如果你正在使用IntelliJ创build一个扩展名为.md文件。 IntelliJ将在编辑时自动显示该文件的预览。

Answer 18

你有没有尝试过使用堆栈编辑 ？ 它将html（或文本）转换为markdown。 您可以在他们的网站上或使用Chrome应用程序访问它。 您可以在编辑器中创build标题和列表，并以缩减格式显示相应的文本。 然后，您可以保存，发布，共享或下载文件。

Answer 19

如果您使用Chrome浏览器，则可以使用扩展名构buildMarkView来查看您的本地Markdown文件。

Answer 20

我写了一个单一的小HTML文件来预览GitHub自述文件 。 它使用GitHub API将Markdown渲染为HTML，并使用Gi​​tHub Primer CSS对HTML进行样式设置。

HTML文件使用Ajax请求来获取您的README.md。 使用任何你喜欢的（你最喜欢的文本编辑器）编辑你的README.md，然后使用HTML文件预览它。

Answer 21

用您喜欢的任何编辑器编辑计算机上的文件。

提交更改并将其推送到一个全新的临时分支，而这个分支目前还没有其他人正在关注 – 也许是您的个人项目分支。

在github上查看文件，并检查你是否满足于html渲染。 如果你git commit --amend它编辑文件， git commit --amend和git push --force直到你。

现在将你的提交合并到其他人关心的分支中，并推送它。 你可能想删除你的新分支。