在提交github之前,如何测试readme.md文件的外观？
Usm*_*ail 204 markdown github github-flavored-markdown
我正在以.md格式为我的github项目编写自述文件.有没有办法在提交到github之前测试我的readme.md文件会是什么样子？
thr*_*ree 130
很多方法:如果你在Mac上,请使用Mou.
如果您想在浏览器中进行测试,可以尝试使用StackEdit,正如@Aaron或Dillinger指出的那样,因为Notepag现在似乎已经失效了.我个人使用Dillinger因为它只是工作并将我的所有文档保存在浏览器的本地数据库中.
- dillinger.io现在似乎也有所下降,虽然它仍然是第一个列出你谷歌"降价在线观众",所以它可能只是我.我成功使用https://stackedit.io/来预览和编辑我的readme.md. (5认同)
- 不幸的是，Mou 看起来并不支持 MacOS Mojave (10.14) (2认同)
Jus*_*ris 26
我通常只是直接在GitHub网站上编辑它,然后点击编辑窗口正上方的"预览".
也许这是自该帖子发布以来添加的新功能.
- 这个解决方案的问题是GitHub(到目前为止)显示了更改的内联差异,如果您想要了解更改的外观而不是实际更改的内容,则预览非常不可用. (7认同)
- @ B12Toaster您可以使用GitHub网站在存储库中创建一个新文件(不保存)并将其命名为`xxx.md`并将代码粘贴到那里.文件扩展名为".md",因此您可以预览更改.您将更新util完成,然后复制文件内容并将其粘贴到原始的`readme.md`文件上. (2认同)
Nik*_*wal 20
Visual Studio Code可以选择编辑和预览md文件更改.由于VS Code与平台无关,因此适用于Windows,Mac和Linux.
要在视图之间切换,请在编辑器中按Ctrl + Shift + V. 您可以使用正在编辑的文件并排查看预览(Ctrl + KV),并在编辑时查看实时反映的更改.
也...
问:VS Code是否支持GitHub Flavored Markdown？
答:不,VS Code使用markdown-it库来定位CommonMark Markdown规范.GitHub正朝着CommonMark规范迈进.
- 不错！我不必安装atom！ (2认同)
- 顺便说一下，我想测试 GitHub 使用的标题链接（/sf/answers/3210248681/），发现 VS Code 也支持它！ (2认同)
Jun*_*ite 12
VS代码
苹果：Command + Shift + V
视窗：Ctrl + Shift + V
详细说明
.md在 VS Code 中打开该文件。选择文件后，使用上面的键盘快捷键。
我使用本地托管的 HTML 文件来预览 GitHub 自述文件。
我查看了几个现有选项，但决定推出自己的选项以满足以下要求：
- 单个文件
- 本地托管（内联网）URL
- 无需浏览器扩展
- 没有本地托管的服务器端处理（例如，没有 PHP）
- 轻量级（例如，没有 jQuery）
- 高保真：使用GitHub渲染Markdown，CSS相同
我将 GitHub 存储库的本地副本保存在“github”目录下的兄弟目录中。
每个 repo 目录都包含一个 README.md 文件：
.../github/
repo-a/
README.md
repo-b/
README.md
etc.
github 目录包含“预览”HTML 文件：
.../github/
readme.html
要预览自述文件，我浏览 github/readme.html，在查询字符串中指定 repo：
http://localhost/github/readme.html?repo-a
或者，您可以将 readme.html 复制到与 README.md 相同的目录中，并省略查询字符串：
http://localhost/github/repo-a/readme.html
如果 readme.html 与 README.md 位于同一目录中，您甚至不需要通过 HTTP 提供 readme.html：您可以直接从您的文件系统打开它。
HTML 文件使用GitHub API在 README.md 文件中呈现 Markdown。有一个速率限制：在撰写本文时，每小时 60 个请求。
适用于 Windows 7 上当前生产版本的 Chrome、IE 和 Firefox。
来源
这是 HTML 文件 (readme.html)：
.../github/
repo-a/
README.md
repo-b/
README.md
etc.
开发者笔记
- 通常，我将代码包装在 IIFE 中，但在这种情况下，我没有看到需要，并认为我会保持简洁
- 我没有打扰支持后级 IE
- 为简洁起见，我省略了错误处理代码（你相信我吗？！）
- 我欢迎 JavaScript 编程技巧
想法
- 我正在考虑为此 HTML 文件创建一个 GitHub 存储库，并将该文件放在 gh-pages 分支中，以便 GitHub 将其作为“普通”网页使用。我会调整文件以接受完整的 URL - README（或任何其他 Markdown 文件）的 URL - 作为查询字符串。我很想知道由 GitHub 托管是否会绕过 GitHub API 请求限制，以及我是否遇到跨域问题（使用 Ajax 请求从不同的域获取 Markdown，而不是为 HTML 页面提供服务的域） .
原始版本（已弃用）
为了好奇心的价值，我保留了原始版本的这个记录。此版本存在以下问题，在当前版本中已解决：
- 需要下载一些相关文件
- 它不支持放入与 README.md 相同的目录中
- 它的 HTML 更脆弱；更容易受到 GitHub 变化的影响
github 目录包含“预览”HTML 文件和相关文件：
.../github/
readme-preview.html
github.css
github2.css
octicons.eot
octicons.svg
octicons.woff
我从 GitHub 下载了 CSS 和 octicons 字体文件：
https://assets-cdn.github.com/assets/github- ... .css
https://assets-cdn.github.com/assets/github2- ... .css
https://github.com/static/fonts/octicons/octicons.* (eot, woff, svg)
我重命名了 CSS 文件以省略原始名称中的一长串十六进制数字。
我编辑了 github.css 以引用 octicons 字体文件的本地副本。
我检查了 GitHub 页面的 HTML，并复制了足够多的围绕自述内容的 HTML 结构以提供合理的保真度；例如，约束宽度。
自述内容的 GitHub CSS、octicons 字体和 HTML“容器”是移动目标：我需要定期下载新版本。
我尝试使用来自各种 GitHub 项目的 CSS。例如：
<link rel="stylesheet" type="text/css"
href="http://rawgit.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css">
但最终决定使用 GitHub 本身的 CSS。
来源
这是 HTML 文件 (readme-preview.html)：
.../github/
readme.html
| 归档时间： |
|
| 查看次数： |
102143 次 |
| 最近记录： |