ShikiHighlighterHighlightOptions Type — astro Architecture
Architecture documentation for the ShikiHighlighterHighlightOptions type/interface in shiki.ts from the astro codebase.
Entity Profile
Dependency Diagram
graph TD 6b6130e4_8fa8_d12c_7fc1_d38b65fab236["ShikiHighlighterHighlightOptions"] 0572c3f9_5381_3e68_d189_656005cca490["shiki.ts"] 6b6130e4_8fa8_d12c_7fc1_d38b65fab236 -->|defined in| 0572c3f9_5381_3e68_d189_656005cca490 style 6b6130e4_8fa8_d12c_7fc1_d38b65fab236 fill:#6366f1,stroke:#818cf8,color:#fff
Relationship Graph
Source Code
packages/markdown/remark/src/shiki.ts lines 37–65
export interface ShikiHighlighterHighlightOptions {
/**
* Generate inline code element only, without the pre element wrapper.
*/
inline?: boolean;
/**
* Enable word wrapping.
* - true: enabled.
* - false: disabled.
* - null: All overflow styling removed. Code will overflow the element by default.
*/
wrap?: boolean | null;
/**
* Chooses a theme from the "themes" option that you've defined as the default styling theme.
*/
defaultColor?: 'light' | 'dark' | string | false;
/**
* Shiki transformers to customize the generated HTML by manipulating the hast tree.
*/
transformers?: ShikiTransformer[];
/**
* Additional attributes to be added to the root code block element.
*/
attributes?: Record<string, string>;
/**
* Raw `meta` information to be used by Shiki transformers.
*/
meta?: string;
}Defined In
Source
Frequently Asked Questions
What is the ShikiHighlighterHighlightOptions type?
ShikiHighlighterHighlightOptions is a type/interface in the astro codebase, defined in packages/markdown/remark/src/shiki.ts.
Where is ShikiHighlighterHighlightOptions defined?
ShikiHighlighterHighlightOptions is defined in packages/markdown/remark/src/shiki.ts at line 37.
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free