Skip to content

reader-chrome-options.ts#

View Markdown

Source

2 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

2 symbols 1 interfaces 1 types 3 members

Reference#

interfaceReaderChromeOptionsPer-control flags for ssg.readerChrome. Omitted fields stay on when the feature…

Per-control flags for ssg.readerChrome.

Omitted fields stay on when the feature itself is enabled.

Signature

export interface ReaderChromeOptions

View source

Members

Properties
NameTypeDescription
backToTopoptional boolean
Back-to-top control that appears after the page is scrolled.
Default true
copyoptional boolean
Copy button on fenced code blocks. The clipboard is read in the browser,
never at build time.
Default true
typeResolvedReaderChrome = false | { copy: boolean; externalLinks: boolean; backToTop: boolean }Resolved reader chrome. false means no extra markup or JS.

Resolved reader chrome. false means no extra markup or JS.

Signature

export type ResolvedReaderChrome = false | { copy: boolean; externalLinks: boolean; backToTop: boolean }

View source