UniAST - Markdown

Version 2.1 by Manuel Leduc on 2025/09/17 10:41

Description

Developers

Exposed components

  • MarkdownToUniAstConverter with name markdownToUniAstConverterName
  • UniAstToMarkdownConverter with name uniAstToMarkdownConverterName

Reference


import { Container } from 'inversify';
import { InlineContent } from '@xwiki/cristal-uniast-api';
import { UniAst } from '@xwiki/cristal-uniast-api';

// @beta (undocumented)
export class ComponentInit {
    constructor(container: Container);
}

// @beta
export interface MarkdownToUniAstConverter {
    parseMarkdown(markdown: string): Promise<UniAst | Error>;
}

// @beta (undocumented)
export const markdownToUniAstConverterName = "MarkdownToUniAstConverter";

// @beta
export interface UniAstToMarkdownConverter {
    // @internal (undocumented)
    convertInlineContents(inlineContents: InlineContent[]): Promise<string>;
    toMarkdown(uniAst: UniAst): Promise<string | Error>;
}

// @beta (undocumented)
export const uniAstToMarkdownConverterName = "UniAstToMarkdownConverter";

Get Connected