Skip to content

fix: remove code block rendering in the note section Closes #1949 #1952

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 4 commits into from
Jun 21, 2025

Conversation

ayush00git
Copy link
Contributor

@ayush00git ayush00git commented Jun 17, 2025

Hii, This PR removes unnecessary code block rendering from the Express 5.0 Node.js requirement note in the 5.x api docs.
I removed backticks (```) from note sections.

Fixes #1949

@ayush00git ayush00git requested review from a team as code owners June 17, 2025 06:34
Copy link

netlify bot commented Jun 17, 2025

Deploy Preview for expressjscom-preview ready!

Name Link
🔨 Latest commit 7c0f715
🔍 Latest deploy log https://app.netlify.com/projects/expressjscom-preview/deploys/6854dc184621c8000880e7d3
😎 Deploy Preview https://deploy-preview-1952--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@ShubhamOulkar ShubhamOulkar left a comment

Choose a reason for hiding this comment

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

Hi @ayush00git, thank you for opening the PR.

In _includes/admonitions/note.html, remove markdown="1" from both the <div> and <p> elements.
Also need to remove backticks (```) from all translation **/4x/api.md and `**/5x/api.md` files.

@ayush00git
Copy link
Contributor Author

Hii @ShubhamOulkar, thanks for clearing the changes to me. I'll revert to this in a few minutes.

@ayush00git
Copy link
Contributor Author

Hii @ShubhamOulkar, i have removed the markdown from both div and p tags in note.html as you told me, and i didn't find any backticks in the 4x and 5x api.md to remove, they already contain plain text notes.
Thanks for guiding me through!

@ShubhamOulkar
Copy link
Member

ShubhamOulkar commented Jun 19, 2025

i didn't find any backticks in the 4x and 5x api.md to remove, they already contain plain text notes.

I said on all translation pages not only in en/ folder.

Also need to remove backticks (```) from all translation **/4x/api.md and `**/5x/api.md` files.

See example file https://github.com/expressjs/expressjs.com/edit/gh-pages/de/4x/api.md

@ShubhamOulkar
Copy link
Member

Let me clarify, only by removing markdown=1 should solve code block rendering.

@ayush00git
Copy link
Contributor Author

I said on all translation pages not only in en/ folder.
This line is not maintainable if we want to change the content string into a paragraph, so let's keep the original capture string variable code.
Please add proper indentations for readability.

Ok thanks for clarifying, i'll make all these changes in a few minutes.

@ayush00git
Copy link
Contributor Author

Hii @ShubhamOulkar, i've made all the requested changes.
If there are more changes to make, please do guide me through them.

Copy link
Member

@ShubhamOulkar ShubhamOulkar left a comment

Choose a reason for hiding this comment

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

Thank you @ayush00git 🙌

@ayush00git
Copy link
Contributor Author

Thanks @ShubhamOulkar for your guidance throughout the issue, btw this was mine first open-source contribution. Thanks a lot !

@ShubhamOulkar
Copy link
Member

@ayush00git keep contributing 😃

Copy link
Member

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@ShubhamOulkar ShubhamOulkar left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

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

LGTM!

@bjohansebas bjohansebas merged commit 8fc9116 into expressjs:gh-pages Jun 21, 2025
9 checks passed
@bjohansebas
Copy link
Member

thanks @ayush00git @ShubhamOulkar!

@ayush00git
Copy link
Contributor Author

Thanks a lot @ShubhamOulkar and @bjohansebas to guide me through, that was my first open source contribution and you guys encouraged me throughout the issue and encouraged me to contribute more.
Thanks a lot.... 😊

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.

remove code block rendering in the note section
3 participants