10000 [BUG] Placeholder/dummy html comments around examples break markdown processing · Issue #2379 · tabler/tabler · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[BUG] Placeholder/dummy html comments around examples break markdown processing #2379

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
Closed
ethancrawford opened this issue May 16, 2025 · 1 comment · Fixed by #2378
Closed

[BUG] Placeholder/dummy html comments around examples break markdown processing #2379

ethancrawford opened this issue May 16, 2025 · 1 comment · Fixed by #2378

Comments

@ethancrawford
Copy link
Collaborator

Browser

N/A

OS

N/A

Screen size

N/A

Describe the bug

#2362 was intended to cover a few extra cases where certain page headings were not being included in documentation tables of contents, and instead of adding new class names into the related filter script to match the headings, an attempt was made at a more generic or less brittle solution by wrapping examples in a 'dummy' html comment to indicate examples, eg: <!--EXAMPLE--> .

Unfortunately, it looks like something about the way that markdown blocks are parsed stops working when these comments are present, causing the HTML to not render correctly.

How to reproduce

  1. Build and run a local copy of the documentation site using any commit based on or more recent than 7fc1d5c
  2. Visit http://127.0.0.1:3010/ui/components/buttons/
  3. Scroll down through the page and observe errors:
  • Many page headings are rendered literally without converting the ## ... into HTML
  • Other errors such as code blocks that are rendered brokenly as HTML UI examples
  • Headings incorrectly missing from the TOC as a result.

Screenshots

Image

Image

JSFiddle

No response
@ethancrawford ethancrawford added bug Something isn't working and removed bug Something isn't working labels May 16, 2025
@ethancrawford
Copy link
Collaborator Author

@BG-Software-BG - Sorry for not catching this previously 😅
Maybe there's a way to solve it while keeping this idea of a dummy wrapper comment, but I'm not sure. Perhaps we just revert to 0c6b487?

@BG-Software-BG BG-Software-BG mentioned this issue May 16, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactor breadcrumb and vector map components, add clipboard functionality tabler/tabler
1 participant
@ethancrawford
0