-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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
The tool of markdown maybe have a bug. #16510
Comments
The way I see it, the rendering via Hugo is canonical. Visual Studio Code's preview is a hint at how the source might get rendered. Would you agree with |
Sorry, I don't agress with the statement. The There are two guides for Markdown which explains the syntax. |
/remove-triage support |
Hi @diguage - I think Hugo is rendering the Markdown correctly. Repeating part of the comment I left on your PR #16452: Thanks for all the detail! Using blockquote '>' syntax: markdownguide.org's blockquotes with other elements section says "Blockquotes can contain other Markdown formatted elements. Not all elements can be used — you’ll need to experiment to see which ones work." So nesting code block syntax inside of blockquote syntax doesn't work. For everyone reading this Issue: regarding the 4 spaces (or 1 tab) at the beginning of L135-139: if you want some text to show up exactly as you write it, without Markdown doing anything to it, indent every line by at least 4 spaces (or 1 tab). Looking at the source code file, the 4 spaces (or 1 tab) at the beginning of each line 135-139 is a mistake. Those spaces should be removed - those lines should not be a blockquote. If you install Hugo, you can test your changes locally. Hugo uses the BlackFriday Markdown processor. |
/priority awaiting-more-evidence |
I used to use the GitHub Format Markdown. |
@diguage are you OK to close this issue? |
I sent a PR for fixing a document style bug: fix markdown syntax by diguage · Pull Request #16452 · kubernetes/website
I review the render result, and I found the tool of Markdown maybe have a bug.
Before I fix the error:
https://kubernetes.io/docs/tasks/configure-pod-container/static-pod/
The four spaces shoud be render as the source code block. So the source code blocks in the four spacke block do not be render as the source code.
The blockquote tag should be used in the case.
After:
https://deploy-preview-16452--kubernetes-io-master-staging.netlify.com/docs/tasks/configure-pod-container/static-pod/
But the blockquote tag does not be render in the right way.
Right render
But it should render like as following (Preview on VS Code):
The text was updated successfully, but these errors were encountered: