Skip to content
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

Different markdown rendering for enumerated list in module documentation #20904

Closed
hungrybluedev opened this issue Feb 25, 2024 · 2 comments · Fixed by #21287
Closed

Different markdown rendering for enumerated list in module documentation #20904

hungrybluedev opened this issue Feb 25, 2024 · 2 comments · Fixed by #21287
Assignees
Labels
Bug This tag is applied to issues which reports bugs.

Comments

@hungrybluedev
Copy link
Member

hungrybluedev commented Feb 25, 2024

Describe the bug

Lists are not being rendered properly for markdown documentation for modules. For a specific example, check the encoding.xml module.

Reproduction Steps

Navigate to the XML module documentation at https://modules.vlang.io/encoding.xml.html and the corresponding markdown document on Github at https://github.com/vlang/v/tree/master/vlib/encoding/xml#readme.

Compare the section Parsing XML Files.

Expected Behavior

The behaviour on Github is correct:

image

The list is rendered properly.

Current Behavior

The behaviour on V's module documentation website is incorrect:

image

The list is rendered incorrectly.

Possible Solution

No response

Additional Information/Context

No response

V version

0.4.4 ee045ed (from the module docs version)

Environment details (OS name and version, etc.)

The environment for generating and publishing module documentation.

Note

You can use the 👍 reaction to increase the issue's priority for developers.

Please note that only the 👍 reaction to the issue itself counts as a vote.
Other reactions and those to comments will not be taken into account.

@hungrybluedev hungrybluedev added the Bug This tag is applied to issues which reports bugs. label Feb 25, 2024
@billpcs
Copy link
Contributor

billpcs commented Feb 27, 2024

Do you happen to know how is this Markdown to XML generation done for the vlang.io site?

By looking at the page source, it seems like the <ol> list is wrongly parsed into a single <li> instead of three.

@hungrybluedev
Copy link
Member Author

It's done with the markdown module. Converts the README to HTML.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug This tag is applied to issues which reports bugs.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants