能否使用Markdown在GitHub的README.md中嵌入Google Document?
GitHub README 嵌入Google Docs相关问题解答
可行性结论
直接在GitHub README.md中嵌入Google Docs的iframe代码完全不可行,GitHub的Markdown渲染器会主动过滤所有iframe、script等存在安全风险的HTML标签,不会渲染这类嵌入内容;你将代码放到代码块中仅会将代码作为文本展示,自然也不会实现嵌入效果。
可落地替代方案
预览图跳转方案(最推荐)
这是目前GitHub生态下的通用替代方案,实现成本低、兼容性无问题:- 打开已公开的Google Docs文档,截取需要展示的预览界面,保存为图片
- 将图片上传到你的GitHub仓库内,建议放在专门的
assets资源目录下统一管理 - 使用Markdown图片加链接的组合语法,用户点击预览图即可直接跳转到Google Docs访问页面,参考语法:
[](你的Google Docs公开访问链接)内容同步方案
如果你希望用户不需要跳转就能直接在README中查看文档内容,可以将Google Docs内容导出为Markdown格式,直接复制对应内容更新到README中,有技术能力的也可以编写简单的自动化脚本定时完成同步操作。GitHub Pages承载方案
如果你一定要实现页面内嵌入效果,可以开启对应仓库的GitHub Pages服务,编写独立的HTML页面放入Google Docs的iframe代码,再在README中添加指向该GitHub Pages页面的跳转入口即可,该方案依然需要用户跳转才能查看嵌入内容。
内容的提问来源于stack exchange,提问作者Jonathan Obise
相关产品推荐
相关产品推荐

