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

Strip comments in theme/sekeleton CHANGELOG.md when displaying in grav website #3835

Open
eauchat opened this issue May 25, 2024 · 1 comment
Assignees

Comments

@eauchat
Copy link

eauchat commented May 25, 2024

Seem like html comments in themes and skeletons CHANGELOG.md files are displayed in the https://getgrav.org/downloads/themes page. I guess that page simply parses the markdown file with a markdown parser. If the parser used supports stripping html comments, maybe it'd make sense to do so.

To see the problem in action, you can compare the beginning of those various views of the same file:
Compare the changelog displayed in getgrav.org, to the way github for example parses the markdown file.
Here is the actual content of the file.

The initial section could be removed in order to avoid the not so pretty display in getgrav.org. But it's also convenient to have the changelog file format described at it's beginning, so that when one edits it, they have the format documentation directly available.

@rhukster
Copy link
Member

It's using Parsedown and should skip the comments, but appears to be stripping the first HTML tag for some reason, causing the broken commented out section. Very much an edge case, so going to be low on my priority list i'm afraid.

@rhukster rhukster self-assigned this Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants