Skip to main content

API Reference

还没翻译译自英文(tanstack.com)本页 5 段都还没译

API Reference

TanStack Highlight is split into explicit entry points. Importing an entry point does not register languages or themes unless that entry point says it does.

Entry pointPurpose
@tanstack/highlightReady-to-use highlighter with every bundled language
@tanstack/highlight/coreHighlighter factory, renderers, and public types with no languages
@tanstack/highlight/markdownCode fence metadata and HAST helpers
@tanstack/highlight/remarkRemark/MDAST integration
@tanstack/highlight/rehypeRehype/HAST integration
@tanstack/highlight/reactFramework-neutral data adapter for React components
@tanstack/highlight/octaneOctane component data and @octanejs/mdx integration
@tanstack/highlight/themeTheme types and CSS generation
@tanstack/highlight/languagesAggregate exports for every bundled language
@tanstack/highlight/languages/*Individually importable language definitions
@tanstack/highlight/themes/*Individually importable themes

Use the default entry for convenience. Use core plus individual language modules when client bundle size matters.