Markdown parser and settings appear to be outdated locally
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- jekyll, ruby
- 领域
- build-system, tooling
调研方向
从复现 index.md 开始，将本地输出与预期的 GitHub Pages 输出进行比较。检查 gem 如何配置 Jekyll 的 Markdown 解析器和设置，并以 CommonMarkGhPages workaround 为目标。完成的标准是本地渲染结果与所示 HTML 一致，包括 HTML 中的 Markdown 和智能省略号。
由索引模型根据 Issue 内容生成。
描述
Before submitting an issue, please be sure to
- Read the contributing instructions
- Update to the latest Gem version (run
bundle update github-pages)
This issue affects
- The site generated by GitHub Pages
- Building sites locally
The GitHub Pages Gem is intended to help users replicate the GitHub Pages build environment locally. If your issue affects both the hosted version and the version previewed locally, you may be better suited reporting seeking support in other forums.
What did you do (e.g., steps to reproduce)
index.md
<section>
# Heading
More...
</section>
What did you expect to happen?
Jekyll should use the same markdown parser and settings locally as GitHub Pages.
<section>
<h1 id="heading">Heading</h1>
<p>More…</p>
</section>
What happened instead?
Jekyll seems to incorrectly use its own default Kramdown parser instead of GFM CommonMark, and as a result cannot handle Markdown in HTML or smart ellipses.
<section>
# Heading
More...
</section>
Additional information
- Link to the source repo (if applicable): https://github.com/nickmccurdy/eslint-config-modern/tree/2699a9c01e68535a3a087759cb11e5f82905db88/docs
As a workaround, I guessed at what GitHub's Jekyll config was and ended up using this, which works the same with this example both locally and on GitHub Pages:
markdown: CommonMarkGhPages
commonmark:
options: ["SMART"]
However, I think the gem should replicate this functionality automatically to keep local testing consistent with GitHub. I'm also not sure if I'm missing other options that may differ in both environments.
- 主要语言
- Ruby
- 星标
- 1.9k
- 派生
- 361
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/pages-gem 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 4/5 3-5 天 新手友好度 25/100
-
难度 4/5 3-5 天 新手友好度 25/100
-
难度 5/5 一周以上 新手友好度 5/100
-
index.html未关闭
难度 5/5 一周以上 新手友好度 5/100
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 95/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
L: javascript T: bug 🐞
难度 2/5 1-3 小时 新手友好度 65/100
dependabot/dependabot-core#16397 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
TheOdinProject/curriculum#31423 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复