Reference

Provides the parsers and serializers from Markdown.

Package name: @xwiki/platform-uniast-markdown

Exposed components

• MarkdownToUniAstConverter with identifier markdownToUniAstConverterName
• UniAstToMarkdownConverter with identifier uniAstToMarkdownConverterName

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

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

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

// @beta
export const markdownToUniAstConverterName = "MarkdownToUniAstConverter";

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

// @beta
export const uniAstToMarkdownConverterName = "UniAstToMarkdownConverter";

Related

Front-end rendering API reference