fix: disable heading detection for carousel, accordion and tabs

[metaboulie]

Fixes #2139

📝 Summary

This pull request addresses the issue of excluding certain headings within specific tags (marimo-carousel, marimo-tabs, marimo-accordion) from being included in the document outline generated by the getOutline function, ensures that the document outline generated by the getOutline function is accurate and excludes irrelevant headings within specified custom tags.

🔍 Description of Changes

Changes Made

1. Excluded Tags Array: Introduced a constant array excludedTags containing the tags marimo-carousel, marimo-tabs, and marimo-accordion.
2. Updated getOutline Function: Modified the getOutline function to skip headings that are within any of the tags specified in the excludedTags array.
3. Test Cases: Added test cases to ensure that headings within the excluded tags are not included in the outline, while headings outside these tags are correctly included.

Problem Addressed

Previously, the getOutline function would include all headings (h1, h2, h3) in the document, even if they were within certain custom tags like marimo-carousel, marimo-tabs, and marimo-accordion. This was problematic because headings within these tags should not be part of the document outline.

Resolution

The problem was resolved by:

• Adding a check in the getOutline function to determine if a heading is within any of the excluded tags.
• If a heading is found within an excluded tag, it is skipped and not added to the outline.
• This ensures that only relevant headings are included in the document outline, improving the accuracy and relevance of the generated outline.

📋 Checklist

• I have read the contributor guidelines.
• For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on Discord, or the community discussions (Please provide a link if applicable).
• I have added tests for the changes made.
• I have run the code and verified that it works as expected.

📜 Reviewers

@akshayka OR @mscolnick

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
marimo-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 29, 2024 1:24pm
marimo-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 29, 2024 1:24pm

[mscolnick]

nice job! and thank you for the tests!

[github-actions]

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.8.5-dev4