Fix inline code rendering in setup docs#176
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Thank you for the PR @ekamran. However, it doesn't address the main issue in #175. For example, this paragraph in the
Since the syntax of that paragraph and the inline code looks correct and should be parsing accordingly. I opened #175 to hear from others what might be the root cause of the problem and how we can fix it. Make another commit if you have a fix for the problem. |
|
Thanks for checking this. I agree, the original Markdown syntax looks valid and GitHub renders it correctly. So this seems more like a Make Handbook rendering/sync issue than a normal Markdown issue. I tried a possible workaround using HTML So I think it is better to wait for input on #175 before adding another commit, unless the team prefers the workaround approach. |
|
We try as much as possible to avoid using HTML tags within the MD files. I think the best approach would be to remove the inline code (`) characters entirely. |
|
Thanks, I checked this a bit more. The source Markdown looks valid and GitHub renders it correctly, but the live Make page output seems to be malformed. For the Database Inspection page, the live HTML currently renders the paragraph like this: Then open The Markdown export also looks corrupted here: So it looks like the issue is happening somewhere in the Make Handbook sync/rendering pipeline, not in GitHub Markdown itself. For this PR, I can still make the requested workaround commit by removing the inline-code backticks from the affected Database Inspection paragraph. But I think the root cause may need a Meta ticket so other handbook pages with valid inline code do not keep hitting the same issue. |
|
I noticed this issue only occurs with localhost URLs that include a port number when we use inline code formatting. As a simple fix, we can remove the backticks(`) and use normal text instead—there's no need for inline code formatting in this case. Otherwise, we'll need to investigate further to understand how we can properly fix the issue. If necessary, we may need help from the Meta team. For now, though, I think the simplest approach is to remove the backticks from these pages:
|
huzaifaalmesbah
left a comment
There was a problem hiding this comment.
@ekamran Thanks for your work on this PR. I noticed that several other changes have been included as well. Since this PR is mainly intended to fix #175, I think we should focus only on resolving the inline code formatting issue here.
If you've identified additional issues, could you please create separate issues and PRs for them? That will help keep this PR focused and make the review process easier.
|
Thanks for the review. I pushed a follow-up commit and narrowed the PR scope. It now only removes inline-code formatting from the localhost URLs with port numbers on the four affected pages. The PR diff should now be 4 files with one line changed in each file. I also reverted the extra cleanup changes so this stays focused on #175. |
3kori
left a comment
There was a problem hiding this comment.
Thank you for the fix.
LGTM, ready to merge.


Summary
Fixes #175
Testing
git diff --check.<br>tags remain in the affected files.