-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
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
Fix code block indentation #18032
Fix code block indentation #18032
Conversation
Before, the code snippets just wouldn't render as such and were empty with the code being interpreted as text below them.
The rendered code blocks in the website look correct: https://docs.brew.sh/Formula-Cookbook#specifying-other-formulae-as-dependencies So, it's a matter with GitHub's Markdown rendering. The indented version presented in this PR seems to render correctly by both Jekyll (Kramdown) and GitHub. |
CI failure is due to rubocop/rubocop-md#28. |
Thanks for your first PR @SimplyDanny! I'm afraid: given this works on docs.brew.sh, sorry, passing on this until rubocop/rubocop-md#28 is resolved. |
Perhaps I'm the only one to read the docs right in the repository on GitHub or in a local editor. The thing is that there they are just broken on these code blocks.
With that said, I wonder why some RuboCop style checks have a higher priority than the actual rendering in all sources. |
@SimplyDanny the primary method of consumption for these docs is https://docs.brew.sh. Beyond that: if syntax highlighting works/does not is not high priority. Similarly: RuboCop is a high priority because it saves maintainer time which is the scarcest resource in this (and most other!) open source project(s). |
(misclick on reopen sorry) |
I hear you and should probably go and set up stricter checks in my projects as well to make my life easier. 😅 |
Before, the code snippets just wouldn't render as such and were empty with the code being interpreted as text below them.