Md2DocxData
Updated 5 min ago
Defined in: packages/mdast/src/index.ts:179
Info associated with mdast nodes by the ecosystem.
This space is guaranteed to never be specified by unist or mdast. But you can use it in utilities and plugins to store data.
This type can be augmented to register custom data. For example:
declare module 'mdast' {
interface Data {
// `someNode.data.myId` is typed as `number | undefined`
myId?: number | undefined
}
}Extends
Data
Extended by
SVGDataBlockquoteDataBreakDataCodeDataDefinitionDataDeleteDataEmphasisDataFootnoteDefinitionDataFootnoteReferenceDataHeadingDataHtmlDataImageReferenceDataInlineCodeDataLinkDataLinkReferenceDataListDataListItemDataParagraphDataRootDataStrongDataTableDataTableRowDataTableCellDataTextDataThematicBreakDataYamlData
Properties
alignment?
optional alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"
Defined in: packages/mdast/src/index.ts:184
allCaps?
optional allCaps?: boolean
Defined in: packages/mdast/src/index.ts:195
bold?
optional bold?: boolean
Defined in: packages/mdast/src/index.ts:185
border?
optional border?: Mutable<IBorderOptions | IBordersOptions>
Defined in: packages/mdast/src/index.ts:183
Styles data compatible with docx - could be passed via inline or block html
checked?
optional checked?: boolean
Defined in: packages/mdast/src/index.ts:208
color?
optional color?: string
Defined in: packages/mdast/src/index.ts:199
emphasisMark?
optional emphasisMark?: Record<string, never>
Defined in: packages/mdast/src/index.ts:193
frame?
optional frame?: IFrameOptions
Defined in: packages/mdast/src/index.ts:202
highlight?
optional highlight?: string
Defined in: packages/mdast/src/index.ts:201
italics?
optional italics?: boolean
Defined in: packages/mdast/src/index.ts:186
name?
optional name?: string
Defined in: packages/mdast/src/index.ts:210
pre?
optional pre?: boolean
Defined in: packages/mdast/src/index.ts:203
smallCaps?
optional smallCaps?: boolean
Defined in: packages/mdast/src/index.ts:196
strike?
optional strike?: boolean
Defined in: packages/mdast/src/index.ts:194
style?
optional style?: string
Defined in: packages/mdast/src/index.ts:206
subScript?
optional subScript?: boolean
Defined in: packages/mdast/src/index.ts:197
superScript?
optional superScript?: boolean
Defined in: packages/mdast/src/index.ts:198
tag?
optional tag?: "symbol" | "object" | "html" | "image" | "link" | "strong" | "text" | "svg" | "blockquote" | "code" | "table" | "a" | "abbr" | "address" | "area" | "article" | "aside" | "audio" | "b" | "base" | "bdi" | "bdo" | "body" | "br" | "button" | "canvas" | "caption" | "cite" | "col" | "colgroup" | "data" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "i" | "iframe" | "img" | "input" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "map" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "progress" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "search" | "section" | "select" | "slot" | "small" | "source" | "span" | "style" | "sub" | "summary" | "sup" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "time" | "title" | "tr" | "track" | "u" | "ul" | "var" | "video" | "wbr" | "animate" | "animateMotion" | "animateTransform" | "circle" | "clipPath" | "defs" | "desc" | "ellipse" | "feBlend" | "feColorMatrix" | "feComponentTransfer" | "feComposite" | "feConvolveMatrix" | "feDiffuseLighting" | "feDisplacementMap" | "feDistantLight" | "feDropShadow" | "feFlood" | "feFuncA" | "feFuncB" | "feFuncG" | "feFuncR" | "feGaussianBlur" | "feImage" | "feMerge" | "feMergeNode" | "feMorphology" | "feOffset" | "fePointLight" | "feSpecularLighting" | "feSpotLight" | "feTile" | "feTurbulence" | "filter" | "foreignObject" | "g" | "line" | "linearGradient" | "marker" | "mask" | "metadata" | "mpath" | "path" | "pattern" | "polygon" | "polyline" | "radialGradient" | "rect" | "set" | "stop" | "switch" | "textPath" | "tspan" | "use" | "view"
Defined in: packages/mdast/src/index.ts:204
type?
optional type?: string
Defined in: packages/mdast/src/index.ts:207
underline?
optional underline?: { color: string; type: "single" | "words" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "none"; } | Record<string, never>
Defined in: packages/mdast/src/index.ts:187
value?
optional value?: string
Defined in: packages/mdast/src/index.ts:209