feat(packages): support cli:omit markers for llm-only doc content#1466
Merged
feat(packages): support cli:omit markers for llm-only doc content#1466
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📦 Bundle Size Report🎨 @videojs/html — no changesPresets (7)
Media (8)
Players (3)
Skins (29)
UI Components (25)
Sizes are marginal over the root entry point. ⚛️ @videojs/react — no changesPresets (7)
Media (7)
Skins (26)
UI Components (20)
Sizes are marginal over the root entry point. 🧩 @videojs/core — no changesEntries (9)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (10)
📦 @videojs/spf — no changesEntries (3)
ℹ️ How to interpretAll sizes are standalone totals (minified + brotli).
Run |
Merged
decepulis
added a commit
that referenced
this pull request
Apr 24, 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
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.
Summary
Adds a
cli:omitmarker pair so doc sections aimed only at LLM readers (served viallms.txt/.mdURLs) can be stripped when the same doc is printed through@videojs/cli docs. The installation guide uses this to keep CLI-invocation instructions in the LLM-facing markdown without re-showing them when the user is already running the CLI.Changes
stripOmitMarkersutil in@videojs/clithat removes<!-- cli:omit <id> -->...<!-- /cli:omit <id> -->blocks from rendered docshandleDocsnow strips omit markers for both the installation-replace path and regular docsllms-markdownintegration emits matchingcli:omitcomments around any element withdata-cli-omitdata-cli-omitand moves thedata-cli-replace="installation"wrapper around the actual install sectionTesting
Covered by new unit tests in
replace.test.ts(four cases: basic removal, no-markers passthrough, multiple blocks, multi-line content) and extendeddocs.test.tsassertions verifying the installation render drops both the markers and the omitted copy.Note
Low Risk
Low risk: changes only affect documentation rendering in the CLI/LLM markdown pipeline, though the new regex-based stripping could remove unintended sections if markers are misused.
Overview
Adds support for
<!-- cli:omit ... -->...<!-- /cli:omit ... -->blocks so LLM-only doc sections can be present in generated.mdfiles but automatically removed when printing docs via@videojs/cli docs.The site’s
llms-markdownbuild step now emitscli:omitmarkers fromdata-cli-omit, and the installation guide restructures its content so the CLI-invocation blurb is omitted while the actual install section remainscli:replace-driven. Tests are updated/added to cover omit stripping and ensure CLI output no longer includes omit markers or their contents.Reviewed by Cursor Bugbot for commit a30d1e0. Bugbot is set up for automated code reviews on this repo. Configure here.