docs: strip tier badges from llms-txt Markdown twins - #1326
Open
codyjlandstrom wants to merge 1 commit into
Open
docs: strip tier badges from llms-txt Markdown twins#1326codyjlandstrom wants to merge 1 commit into
codyjlandstrom wants to merge 1 commit into
Conversation
The TiersList badge component renders inside heading HTML, so the generated Markdown twins concatenated badge labels into heading text (e.g. `# CatalogScaleEnterpriseSelf-Hosted`). Add a rehype plugin that removes the badge elements before Markdown conversion, following the same pattern as rehypeStripHashLinks. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Cody Landstrom <cody@okteto.com>
codyjlandstrom
requested review from
ifbyol,
pchico83 and
rlamana
as code owners
August 11, 2026 14:57
✅ Deploy Preview for okteto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ifbyol
approved these changes
Aug 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
The Markdown twins generated by
@signalwire/docusaurus-plugin-llms-txtconcatenated tier badge labels into headings. For example,build/docs/admin/catalog.mdopened with# CatalogScaleEnterpriseSelf-Hosted. The badges come from theTiersListcomponent, which renders inside the heading HTML.This PR adds a
rehypeStripTierBadgesplugin indocusaurus.config.js. It removes the badge elements (div.TiersList) from the page HTML before it is converted to Markdown. It follows the same dependency-free pattern as the existingrehypeStripHashLinksplugin and is registered next to it in the llms-txt plugin'sbeforeDefaultRehypePlugins.Verification
I ran
yarn buildand compared the headings of all nine affected pages against the previous build output:# CatalogScaleEnterpriseSelf-Hostedis now# Catalog.reference/okteto-cli.md,### analyticsPlatformOpen-Sourceis now### analytics, and the same applies toself-hosted/manage/air-gapped.md.llms-full.txtfinds no remaining concatenated badge text.Known limitation
Link titles in
llms.txtitself still contain the badge text, for example- [Catalog ScaleEnterpriseSelf-Hosted](/admin/catalog.md). The plugin extracts each page title from the firsth1of the raw HTML before the configurable rehype pipeline runs, so no config-level plugin can clean it. That fix needs a patch to the plugin (or an upstream change) and is being handled separately.🤖 Generated with Claude Code