mdast2docx logo Md2Docx
Version 1.8.0API DocsInterfaces

SVGData

Updated 5 min ago

Defined in: packages/mdast/src/index.ts:40

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

Properties

alignment?

optional alignment?: "center" | "left" | "right" | "start" | "end" | "both" | "mediumKashida" | "distribute" | "numTab" | "highKashida" | "lowKashida" | "thaiDistribute"

Defined in: packages/mdast/src/index.ts:184

Inherited from

Data.alignment

allCaps?

optional allCaps?: boolean

Defined in: packages/mdast/src/index.ts:195

Inherited from

Data.allCaps

bold?

optional bold?: boolean

Defined in: packages/mdast/src/index.ts:185

Inherited from

Data.bold

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

Inherited from

Data.border

checked?

optional checked?: boolean

Defined in: packages/mdast/src/index.ts:208

Inherited from

Data.checked

color?

optional color?: string

Defined in: packages/mdast/src/index.ts:199

Inherited from

Data.color

emphasisMark?

optional emphasisMark?: Record<string, never>

Defined in: packages/mdast/src/index.ts:193

Inherited from

Data.emphasisMark

frame?

optional frame?: IFrameOptions

Defined in: packages/mdast/src/index.ts:202

Inherited from

Data.frame

highlight?

optional highlight?: string

Defined in: packages/mdast/src/index.ts:201

Inherited from

Data.highlight

italics?

optional italics?: boolean

Defined in: packages/mdast/src/index.ts:186

Inherited from

Data.italics

mermaid?

optional mermaid?: string

Defined in: packages/mdast/src/index.ts:44

Mermaid source code

name?

optional name?: string

Defined in: packages/mdast/src/index.ts:210

Inherited from

Data.name

pre?

optional pre?: boolean

Defined in: packages/mdast/src/index.ts:203

Inherited from

Data.pre

smallCaps?

optional smallCaps?: boolean

Defined in: packages/mdast/src/index.ts:196

Inherited from

Data.smallCaps

strike?

optional strike?: boolean

Defined in: packages/mdast/src/index.ts:194

Inherited from

Data.strike

style?

optional style?: string

Defined in: packages/mdast/src/index.ts:206

Inherited from

Data.style

subScript?

optional subScript?: boolean

Defined in: packages/mdast/src/index.ts:197

Inherited from

Data.subScript

superScript?

optional superScript?: boolean

Defined in: packages/mdast/src/index.ts:198

Inherited from

Data.superScript

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

Inherited from

Data.tag

type?

optional type?: string

Defined in: packages/mdast/src/index.ts:207

Inherited from

Data.type

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

Inherited from

Data.underline

value?

optional value?: string

Defined in: packages/mdast/src/index.ts:209

Inherited from

Data.value

On this page