Open
Conversation
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.
This pull request introduces a standardized
toMarkdownexport for many UI components, enabling each to serialize itself into Markdown format. This provides a foundation for rendering or exporting documentation content as clean Markdown, and ensures consistent Markdown output across various custom components. The changes also include the addition of a newCopyPageDropdowncomponent, which allows users to copy the current page as Markdown, URL, or a prompt-ready format for LLMs.Markdown serialization support for components:
Added
toMarkdownfunctions to most components in the_componentsdirectory, each returning a Markdown representation of the component's content or an empty string if not applicable. This includes components such asAnnotation,CodeBlock,CodeTab,CommonParam,DataReference,DataReferenceRow,DocShot,DocsImage,DocsVideo,Example,GlossaryTerm,GuideGrid,ImageWrapper,InteractiveTree, andLanguageIcon. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]Updated
MultiCodeBlock.tsxto re-export thetoMarkdownfunction fromCodeBlock.tsxfor consistency and backward compatibility.New feature: CopyPageDropdown component
CopyPageDropdowncomponent, which provides a UI for copying the current page as Markdown, as a URL, or as a context-wrapped prompt for LLMs. The component fetches the Markdown source of the page and supports user feedback via a toast notification.Minor type and prop improvements:
GlossaryTermPropstype to allowchildrento be of typeunknown, aligning with the usage in other components.