这个项目能做什么
github-markdown-css是一个小型CSS包,其既定目标是用最少的CSS代码复刻GitHub对渲染后Markdown应用的视觉样式。该样式表是生成而非手工编辑的;README指引贡献者前往独立的generate-github-markdown-css仓库。
使用方法简单:导入github-markdown.css,在包含渲染后Markdown的容器上添加markdown-body类,并设置宽度。README指出GitHub使用980px宽度和45px内边距,移动端为15px内边距,并提供了包含box-sizing、min-width、max-width、margin auto以及针对窄视口的媒体查询示例。还通过prefers-color-scheme展示了暗色模式的背景颜色。
该包提供七种主题:默认主题通过prefers-color-scheme在明暗之间自动切换,还有仅亮色、仅暗色、暗色暗淡、暗色高对比度、暗色色盲(红色盲和绿色盲)以及亮色色盲变体。
对于匹配这些样式的HTML,README建议使用GitHub的/markdown API,该API生成GitHub自身产生的HTML。它指出其他Markdown解析器大多也能与这些样式配合使用,并推荐使用starry-night进行模仿GitHub的代码高亮。
安装选项包括手动下载文件、使用CDNJS或通过npm install github-markdown-css。还提供了演示页面链接。
一个故障排除说明指出,暗色模式下表格字体变黑等样式问题可能源于浏览器进入怪异模式;在页面顶部包含doctype可避免此问题。开发时,运行npm run make可更新CSS。
评论
0 评分人数达到10人后显示
登录后参与讨论。