MINOR: Improve README.md formatting and consistency #21327
Conversation
| ### Build a jar and run it ### | ||
| ./gradlew jar | ||
| ### Build a jar and run it | ||
| ```bash |
There was a problem hiding this comment.
Out of curiosity, what is the difference in the output?
There was a problem hiding this comment.
@chia7712 Good question! The changes improve readability and follow Markdown best practices:
- Header formatting: Removed trailing ### for cleaner, standard Markdown
- Code blocks: Added ```bash for proper syntax highlighting instead of plain indentation
- Visual improvement: Commands now have colored syntax highlighting in GitHub/IDEs
This makes the documentation more professional and easier to read for new contributors.
There was a problem hiding this comment.
@JeevanYewale thanks for your explanation. please address @squah-confluent comment on the README.md updates for consistency
|
@JeevanYewale Thanks for your contribution! Just fyi, the second half of the README has been missed. |
Thanks for pointing it out! I’ll update the second half of the README shortly. |
chia7712
changed the title
|
@JeevanYewale thanks for this contribution |
3 participants
Converted indented code blocks to fenced code blocks (```bash) to enable
syntax highlighting and the "copy" button feature.
Removed redundant trailing # characters from headers to align with
standard Markdown style.
Reviewers: Sean Quah squah@confluent.io, Chia-Ping Tsai
chia7712@gmail.com