我正在为我的github项目写一个自述文件。md格式。有什么方法可以测试我的自述。Md文件在提交到github之前会是什么样子?
当前回答
我只是创建了一个“功能”分支,并将其推送到github,在那里我做出了改变,这变得可见,他们将如何在github中看起来。
然后,当我满意的时候,我就把base调回main,或者对main执行一个pull请求,不管你碰巧在使用哪个进程。
使用git时,很少需要在本地进行测试,除非您的存储库位于公司防火墙后面,或者需要离线工作。
在这种情况下,Atom和VScode都有不错的Markdown渲染器,不足以在github上显示你的更改,但足以看到你的更改是否朝着正确的方向发展。
其他回答
针对Visual Studio用户(不是VS CODE)。
安装Markdown编辑器扩展
这样,当你打开一个README。医生,你可以在右边看到现场预览。
有很多方法:如果你用的是Mac,使用Mou。
如果您想在浏览器中测试,您可以尝试StackEdit,正如@Aaron或Dillinger指出的那样,因为Notepag现在似乎已经关闭了。就我个人而言,我使用Dillinger,因为它可以将我所有的文档保存在浏览器的本地数据库中。
一种方法是使用Pandoc(非常有用)。
复制你的降价投诉文本到剪贴板 运行: Xsel -b | pandoc -s -f markdown -t HTML | xclip -select clipboard -t text/ HTML | Xsel -b 粘贴生成的格式化文本(例如在电子邮件或LibreOffice上)。
你说你用的是Linux。你只需要安装pandoc, xsel和xclip包。
我知道这个问题很老了,也许有人在谷歌上搜索了如何到达这里。 这就是我对这个问题的看法。
你可以使用原子文本编辑器和切换markdown预览甚至在github风格。
新闻
ctrl+shift+m
窗口将弹出或使用Packages—>Markdown预览。
希望这能帮助到一些人。
Markdown预览,在之前的评论中提到的Sublime Text插件不再与ST2兼容,但只支持Sublime Text 3(自2018年春季以来)。
它的优点是:它支持GFM, GitHub调味Markdown,它可以做的比常规Markdown多一点。如果你想知道你的.mds在GH上是什么样子的,这是有关联的。(包括这一点信息,因为OP自己没有添加GFM标签,其他寻找解决方案的人可能也不知道它。)
如果你在线,你可以将它与GitHub API一起使用,不过你应该为此获得一个个人访问令牌,因为没有身份验证的API调用是有限的。在插件的文档中有更多关于解析GFM的信息。
推荐文章
- 在Markdown Jekyll中使用图像说明
- 如何修改GitHub拉请求?
- 如何在Github和本地删除最后n次提交?
- 如何将文件附加到GitHub问题?
- Slack Markdown链接没有解决
- 如何添加谷歌分析跟踪ID到GitHub页面
- 差异语法突出显示在Github Markdown
- 我如何创建一个文本框的笔记在markdown?
- /dist目录在开源项目中的意义是什么?
- 我如何从现有回购的分支创建一个新的GitHub回购?
- 在git中压缩提交是什么意思?
- 如何在GitHub上找到存储库项目的创建日期?
- 如何设置一个git项目使用外部回购子模块?
- 在Markdown中创建一个没有标题的表
- 强制LF eol在git的回购和工作副本