我正在为我的github项目写一个自述文件。md格式。有什么方法可以测试我的自述。Md文件在提交到github之前会是什么样子?
当前回答
自2012年(当这个问题被创建时)GitHub本身可以:
在常规存储库中创建并显示Markdown文档的预览(自2011年8月以来一直如此) 或者,如果你不想直接影响你的存储库,对gist做同样的事情(自2020年12月起) 即使没有提交要点,自2021年11月起,您也可以在您正在编辑(但尚未提交)的要点中预览Markdown文档
一旦要旨的预览看起来不错,你就可以将要旨的标记复制到你当地的README中。Md,添加,提交和推送。
其他回答
VS代码
Mac: Command + Shift + V
Windows操作系统:Ctrl + Shift + V
详细说明
在VS Code中打开.md文件。选定文件后,使用上面的键盘快捷键。
针对Visual Studio用户(不是VS CODE)。
安装Markdown编辑器扩展
这样,当你打开一个README。医生,你可以在右边看到现场预览。
这是一个相当老的问题,但由于我是在网上搜索时偶然发现的,也许我的答案对其他人有用。 我刚刚发现了一个非常有用的CLI工具来渲染GitHub风味markdown: grip。它使用GitHub的API,因此渲染得很好。
坦率地说,《grip》的开发者对这些类似的问题有更详细的回答:
是否有一个命令行实用程序渲染github风味markdown? 编辑GitHub的Readme.md的最好方法是什么?
我使用markdownlivepreview: https://markdownlivepreview.com/
这是非常容易,简单和快速。
有很多方法:如果你用的是Mac,使用Mou。
如果您想在浏览器中测试,您可以尝试StackEdit,正如@Aaron或Dillinger指出的那样,因为Notepag现在似乎已经关闭了。就我个人而言,我使用Dillinger,因为它可以将我所有的文档保存在浏览器的本地数据库中。
推荐文章
- 使用pandoc从Markdown转换为PDF时设置空白大小
- 如何修复Github页面上的HTTP 404 ?
- 如何显示数学方程在一般github的markdown(不是github的博客)
- 无法推送到远程分支,无法解析到分支
- 使用Markdown的Sphinx而不是reST
- 如何在GitHub上创建自己的存储库?
- Github“更新被拒绝,因为远程包含您在本地没有的工作。”
- 降价和图像对齐
- 如何在不同的用户名下推送到GitHub ?
- 在最初创建提交的GitHub上找到一个Pull Request
- Git凭据助手-更新密码
- 标签和释放的区别是什么?
- 切换到另一个Git标记
- Heroku和GitHub:“项目无法检索,内部服务器错误”
- 将现有项目推到Github