Markdown parser and settings appear to be outdated locally
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 42/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- jekyll, ruby
- Domaine
- build-system, tooling
Piste de recherche
Commencez par reproduire index.md et comparez la sortie locale avec la sortie attendue de GitHub Pages. Examinez la façon dont le gem configure l’analyseur Markdown et les paramètres de Jekyll, en prenant le contournement CommonMarkGhPages comme référence. Le travail est terminé lorsque le rendu local correspond au HTML affiché, y compris le Markdown dans le HTML et les points de suspension typographiques.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Ruby
- Étoiles
- 1.9k
- Forks
- 361
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/pages-gem
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Error when building docker imageOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
-
Serving SQLite database files with sql.js-httpvfs broken due to gzip encoding on HEAD requestsOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 5/100
-
index.htmlOuverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 5/100
Toutes les issues de github/pages-gem
Issues similaires
-
DB上でコメント本文がNULLを許容しているOuverteバグ
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
-
security
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
IBM/ai-security-baseline#25 ·
-
security
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Mend: dependency security vulnerability
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour