Skip to content

Use triple backticks for markdown snippets in README.md #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 15, 2025

Conversation

danielhenrymantilla
Copy link
Contributor

@danielhenrymantilla danielhenrymantilla commented Jul 1, 2025

Hey, very nice tool and idea, I must say I love it! Looking forward to sharing a .md file over Github saying that that is both the build code and its pretty/rendered documentation 🤩


This PR is about an æsthetic/subjective nit, so feel free to (politely) dismiss it.

Nonetheless, I do find that using ~~~ for code blocks in Markdown to be an extremely rare sight (in fact, TIL!), especially in the context of markdown-masquerading tools such as Discord, which do not interpret ~~~ as introducing a code block. What this, in turn, entails, is that people coming across your tool will run into a bit more strangeness / impedance, and as we all know it, the budget for it is limited, and for some by quite a bit. Doing the "typical" thing, albeit boring, ought to help in this regard :)

Which issue does this fix?

None.

Describe the solution

README.md-only adjustments:

  1. Replace outer ```s with ````;
  2. Replace ~~~ with ```

Rendered

This is an æsthetic/subjective nit, so feel free to dismiss it. Nonetheless, I do find that using `~~~` for code blocks in Markdown to be an extremely rare sight (in fact, TIL!), especially in the context of markdown-masquerading tools such as Discord, which do _not_ interpret `~~~` as introducing a code block. What this, in turn, entails, is that people coming across your tool will run into a bit more strangeness / impedance, and as we all know it, the budget for it is limited, and for some by quite a bit.
Doing the "typical" thing, albeit boring, ought to help in this regard :)
@jacobdeichert
Copy link
Owner

Thanks for the PR @danielhenrymantilla

Tilde fenced code blocks come from GitHub Flavored Markdown as far as I recall.

TIL about nested fenced code blocks with quadruple backticks.

Given standard markdown doesn't support tildes AFAIK, I think I agree using backticks in the docs is better 👍


Looks like Windows CI is failing. I bet the Windows actions runtime has had some recent changes that I haven't caught up to. If you have time to look into that, that would be appreciated. Else I'll try to find time in the next few weeks to investigate further.

@jacobdeichert
Copy link
Owner

I fixed windows CI on master, updated this branch with the latest changes

Copy link
Owner

@jacobdeichert jacobdeichert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI passed 👍

@jacobdeichert jacobdeichert merged commit d5e9bce into jacobdeichert:master Jul 15, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants