Skip to content

Make the content of generated md files to be markdown compatible #44087

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Make the content of generated md files to be markdown compatible #44087

wants to merge 4 commits into from
+29 −1

Conversation

thil4n
Copy link

@thil4n thil4n commented May 5, 2025

Purpose

This PR fixes the Markdown compatibility issue in the generated readme.md file for bal new -t lib command.

Fixes #42907

Approach

Edit the static file cli/ballerina-cli/src/main/resources/new_cmd_defaults/lib-readme.md.

Check List

  • Read the Contributing Guide
  • Updated Change Log
  • Checked Tooling Support (#)
  • Added necessary tests
    • Unit Tests
    • Spec Conformance Tests
    • Integration Tests
    • Ballerina By Example Tests
  • Increased Test Coverage
  • Added necessary documentation
    • API documentation
    • Module documentation in Module.md files
    • Ballerina By Examples

@thil4n thil4n requested a review from azinneera as a code owner May 5, 2025 08:38
@thil4n thil4n requested a review from azinneera June 26, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@azinneera azinneera Awaiting requested review from azinneera azinneera is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Improvement]: Make the content of generated md files to be markdown compatible
2 participants
@thil4n @azinneera