ballerina-platform / ballerina-lang

The Ballerina Programming Language
https://ballerina.io/
Apache License 2.0
3.58k stars 738 forks source link

[Improvement]: Make the content of generated md files to be markdown compatible #42907

Open TharmiganK opened 3 months ago

TharmiganK commented 3 months ago

Description

We can create a ballerina library package using the following command:

$ bal new -t lib socialMedia

This creates the module.md and package.md with the content which is not markdown compatible

Describe your problem(s)

The generated md file has the following line which is not markdown compatible:

Prints "Hello, World!" with a main function.
[//]: # (above is the package summary)
Screenshot 2024-06-12 at 09 18 36

Describe your solution(s)

Generate some descriptive sample which is markdown compatible

Related area

-> Other Area

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

lwpamihiranga commented 2 months ago

Hi,

I've noticed that these .md files are not generated in the master branch build, but they are available when tested with Ballerina version 2201.9.1 (Swan Lake Update 9). Could you please let me know which branch would be the most appropriate for me to apply the fix to?

Thanks!

bal-new-master-vs-22010901