我正在为我的github项目写一个自述文件。md格式。有什么方法可以测试我的自述。Md文件在提交到github之前会是什么样子?
当前回答
针对Visual Studio用户(不是VS CODE)。
安装Markdown编辑器扩展
这样,当你打开一个README。医生,你可以在右边看到现场预览。
其他回答
我只是创建了一个“功能”分支,并将其推送到github,在那里我做出了改变,这变得可见,他们将如何在github中看起来。
然后,当我满意的时候,我就把base调回main,或者对main执行一个pull请求,不管你碰巧在使用哪个进程。
使用git时,很少需要在本地进行测试,除非您的存储库位于公司防火墙后面,或者需要离线工作。
在这种情况下,Atom和VScode都有不错的Markdown渲染器,不足以在github上显示你的更改,但足以看到你的更改是否朝着正确的方向发展。
自2012年(当这个问题被创建时)GitHub本身可以:
在常规存储库中创建并显示Markdown文档的预览(自2011年8月以来一直如此) 或者,如果你不想直接影响你的存储库,对gist做同样的事情(自2020年12月起) 即使没有提交要点,自2021年11月起,您也可以在您正在编辑(但尚未提交)的要点中预览Markdown文档
一旦要旨的预览看起来不错,你就可以将要旨的标记复制到你当地的README中。Md,添加,提交和推送。
我知道这个问题很老了,也许有人在谷歌上搜索了如何到达这里。 这就是我对这个问题的看法。
你可以使用原子文本编辑器和切换markdown预览甚至在github风格。
新闻
ctrl+shift+m
窗口将弹出或使用Packages—>Markdown预览。
希望这能帮助到一些人。
这是一个相当老的问题,但由于我是在网上搜索时偶然发现的,也许我的答案对其他人有用。 我刚刚发现了一个非常有用的CLI工具来渲染GitHub风味markdown: grip。它使用GitHub的API,因此渲染得很好。
坦率地说,《grip》的开发者对这些类似的问题有更详细的回答:
是否有一个命令行实用程序渲染github风味markdown? 编辑GitHub的Readme.md的最好方法是什么?
一种方法是使用Pandoc(非常有用)。
复制你的降价投诉文本到剪贴板 运行: Xsel -b | pandoc -s -f markdown -t HTML | xclip -select clipboard -t text/ HTML | Xsel -b 粘贴生成的格式化文本(例如在电子邮件或LibreOffice上)。
你说你用的是Linux。你只需要安装pandoc, xsel和xclip包。
推荐文章
- 是否有一个链接到GitHub下载文件的最新版本的存储库?
- GitHub -致命:无法读取用户名https://github.com':没有这样的文件或目录
- Github:我能看到回购的下载数量吗?
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌
- 我可以在GitHub上对要点进行拉请求吗?
- Git:在推送后删除提交的文件
- 在GitHub中编辑git提交消息
- Github:导入上游分支到fork
- GitHub上的分叉和克隆有什么区别?