expressjs.com icon indicating copy to clipboard operation
expressjs.com copied to clipboard

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

Open ayush00git opened this issue 6 months ago • 1 comments

Hii, This PR removes unnecessary code block rendering from the Express 5.0 Node.js requirement note in the 5.x api docs. I replaced the captured 'node-version' block with a inline string to avoid the code-style formatting.

Fixes #1949

ayush00git avatar Jun 17 '25 06:06 ayush00git

Deploy Preview for expressjscom-preview ready!

Name Link
Latest commit 7c0f715c9302e8df586e8ed622519325bc9bbbee
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.

netlify[bot] avatar Jun 17 '25 06:06 netlify[bot]

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

ayush00git avatar Jun 19 '25 03:06 ayush00git

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!

ayush00git avatar Jun 19 '25 04:06 ayush00git

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 avatar Jun 19 '25 04:06 ShubhamOulkar

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

ShubhamOulkar avatar Jun 19 '25 04:06 ShubhamOulkar

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 avatar Jun 19 '25 05:06 ayush00git

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

ayush00git avatar Jun 19 '25 05:06 ayush00git

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

ayush00git avatar Jun 19 '25 14:06 ayush00git

@ayush00git keep contributing 😃

ShubhamOulkar avatar Jun 19 '25 14:06 ShubhamOulkar

thanks @ayush00git @ShubhamOulkar!

bjohansebas avatar Jun 21 '25 00:06 bjohansebas

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.... 😊

ayush00git avatar Jun 21 '25 07:06 ayush00git