我正在为我的github项目写一个自述文件。md格式。有什么方法可以测试我的自述。Md文件在提交到github之前会是什么样子?
当前回答
我通常只是直接在GitHub网站上编辑它,然后点击编辑窗口上方的“预览”。
也许这是自这篇文章以来添加的一个新功能。
其他回答
自2012年(当这个问题被创建时)GitHub本身可以:
在常规存储库中创建并显示Markdown文档的预览(自2011年8月以来一直如此) 或者,如果你不想直接影响你的存储库,对gist做同样的事情(自2020年12月起) 即使没有提交要点,自2021年11月起,您也可以在您正在编辑(但尚未提交)的要点中预览Markdown文档
一旦要旨的预览看起来不错,你就可以将要旨的标记复制到你当地的README中。Md,添加,提交和推送。
如果你正在使用Pycharm(或其他Jetbrains IDE,如Intellij, RubyMine, PHPStorm等),在你的IDE中有多个免费的Markdown支持插件,允许在编辑时实时预览。Markdown Navigator插件相当不错。如果您在IDE中打开一个.md文件,最新版本将提供安装支持插件并显示列表。
Atom工作得很好-只需打开Markdown文件,并按Ctrl+Shift+M切换Markdown预览面板旁边。它还处理HTML和图像。
有很多方法:如果你用的是Mac,使用Mou。
如果您想在浏览器中测试,您可以尝试StackEdit,正如@Aaron或Dillinger指出的那样,因为Notepag现在似乎已经关闭了。就我个人而言,我使用Dillinger,因为它可以将我所有的文档保存在浏览器的本地数据库中。
你可能想看看这个:
https://github.com/kristjanjansen/md2html
推荐文章
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌
- 我可以在GitHub上对要点进行拉请求吗?
- Git:在推送后删除提交的文件
- 在GitHub中编辑git提交消息
- Github:导入上游分支到fork
- GitHub上的分叉和克隆有什么区别?
- 如何将现有的解决方案从Visual Studio 2013添加到GitHub
- 是否可以在GitHub上搜索特定的文件名?
- 如何将LaTeX与Markdown混合?