RemarkSectionProps
Updated 9 hr ago
Defined in: packages/remark-docx/src/index.ts:24
Extends
ISectionProps
Properties
footerAst?
optional footerAst?: FooterAst
Defined in: packages/core/src/utils/index.ts:124
Pre-parsed MDAST Root for section footers.
Inherited from
ISectionProps.footerAst
footerMarkdown?
optional footerMarkdown?: FooterMarkdown
Defined in: packages/remark-docx/src/index.ts:26
footers?
readonly optional footers?: object
Defined in: node_modules/.pnpm/docx@9.13.0/node_modules/docx/dist/index.d.ts:7341
Optional footer definitions for the section.
default?
readonly optional default?: Footer
Default footer for all pages (when first/even not specified).
even?
readonly optional even?: Footer
Footer for even-numbered pages.
first?
readonly optional first?: Footer
Footer for the first page of the section.
Inherited from
ISectionProps.footers
footnoteProps?
optional footnoteProps?: Omit<Mutable<IParagraphOptions>, "children"> & object & Mutable<Omit<IRunOptions, "children">> & object
Defined in: packages/core/src/utils/index.ts:114
Configures paragraph and run styling options specifically for footnote content rendering
Type Declaration
checked?
optional checked?: boolean | null
pre?
optional pre?: boolean
pre?
optional pre?: boolean
Inherited from
ISectionProps.footnoteProps
headerAst?
optional headerAst?: HeaderAst
Defined in: packages/core/src/utils/index.ts:119
Pre-parsed MDAST Root for section headers.
Inherited from
ISectionProps.headerAst
headerMarkdown?
optional headerMarkdown?: HeaderMarkdown
Defined in: packages/remark-docx/src/index.ts:25
headers?
readonly optional headers?: object
Defined in: node_modules/.pnpm/docx@9.13.0/node_modules/docx/dist/index.d.ts:7332
Optional header definitions for the section.
default?
readonly optional default?: Header
Default header for all pages (when first/even not specified).
even?
readonly optional even?: Header
Header for even-numbered pages.
first?
readonly optional first?: Header
Header for the first page of the section.
Inherited from
ISectionProps.headers
plugins?
optional plugins?: (Optional<IPlugin<EmptyNode>> | undefined)[]
Defined in: packages/core/src/utils/index.ts:104
List of plugins to extend conversion functionality.
Inherited from
ISectionProps.plugins
properties?
readonly optional properties?: ISectionPropertiesOptions
Defined in: node_modules/.pnpm/docx@9.13.0/node_modules/docx/dist/index.d.ts:7350
Section properties such as page size, margins, and orientation.
Inherited from
ISectionProps.properties
trimInnerSpaces?
optional trimInnerSpaces?: boolean
Defined in: packages/core/src/utils/index.ts:109
Should trim multiple white spaces in text nodes? 'a b' will become 'a b'
Inherited from
ISectionProps.trimInnerSpaces
useTitle?
optional useTitle?: boolean
Defined in: packages/core/src/utils/index.ts:99
If true, H1 corresponds to the title, H2 to Heading1, etc.
Default
trueInherited from
ISectionProps.useTitle