[ WEBSITE | ISSUES | FORUM | GITTER ]
\nThis is a (non-core) module for ProseMirror.\nProseMirror is a well-behaved rich semantic content editor based on\ncontentEditable, with support for collaborative editing and custom\ndocument schemas.
\nThis module implements a ProseMirror\nschema that corresponds to\nthe document schema used by CommonMark, and\na parser and serializer to convert between ProseMirror documents in\nthat schema and CommonMark/Markdown text.
\nThis code is released under an\nMIT license.\nThere's a forum for general\ndiscussion and support requests, and the\nGithub bug tracker\nis the place to report issues.
\nWe aim to be an inclusive, welcoming community. To make that explicit,\nwe have a code of\nconduct that applies\nto communication around the project.
\nschema: Schema<"doc" | "paragraph" | "blockquote" | "horizontal_rule" | "heading" | "code_block" | "ordered_list" | "bullet_list" | "list_item" | "text" | "image" | "hard_break", "em" | "strong" | "link" | "code">Document schema for the data model used by CommonMark.
\nclass\n MarkdownParserA configuration of a Markdown parser. Such a parser uses\nmarkdown-it to\ntokenize a file, and then runs the custom rules it is given over\nthe tokens to create a ProseMirror document tree.
\nnew MarkdownParser(schema: Schema, tokenizer: any, tokens: Object<ParseSpec>)Create a parser with the given configuration. You can configure\nthe markdown-it parser to parse the dialect you want, and provide\na description of the ProseMirror entities those tokens map to in\nthe tokens object, which maps token names to descriptions of\nwhat to do with them. Such a description is an object, and may\nhave the following properties:
schema: SchemaThe parser's document schema.
\ntokenizer: anyThis parser's markdown-it tokenizer.
\ntokens: Object<ParseSpec>The value of the tokens object used to construct this\nparser. Can be useful to copy and modify to base other parsers\non.
parse(text: string) → anyParse a string as CommonMark markup,\nand create a ProseMirror document as prescribed by this parser's\nrules.
\ninterface\n ParseSpecObject type used to specify how Markdown tokens should be parsed.
\nnode?: stringThis token maps to a single node, whose type can be looked up\nin the schema under the given name. Exactly one of node,\nblock, or mark must be set.
block?: stringThis token (unless noCloseToken is true) comes in _open\nand _close variants (which are appended to the base token\nname provides a the object property), and wraps a block of\ncontent. The block should be wrapped in a node of the type\nnamed to by the property's value. If the token does not have\n_open or _close, use the noCloseToken option.
mark?: stringThis token (again, unless noCloseToken is true) also comes\nin _open and _close variants, but should add a mark\n(named by the value) to its content, rather than wrapping it\nin a node.
attrs?: AttrsAttributes for the node or mark. When getAttrs is provided,\nit takes precedence.
getAttrs?: fn(token: any, tokenStream: any[], index: number) → AttrsA function used to compute the attributes for the node or mark\nthat takes a markdown-it\ntoken and\nreturns an attribute object.
\nnoCloseToken?: booleanIndicates that the markdown-it\ntoken has\nno _open or _close for the nodes. This defaults to true\nfor code_inline, code_block and fence.
ignore?: booleanWhen true, ignore content for the matched token.
\ndefaultMarkdownParser: MarkdownParserA parser parsing unextended CommonMark,\nwithout inline HTML, and producing a document in the basic schema.
\nclass\n MarkdownSerializerA specification for serializing a ProseMirror document as\nMarkdown/CommonMark text.
\nnew MarkdownSerializer(nodes: Object<fn(state: MarkdownSerializerState, node: Node, parent: Node, index: number)>, marks: Object<Object>, options?: Object = {})Construct a serializer with the given configuration. The nodes\nobject should map node names in a given schema to function that\ntake a serializer state and such a node, and serialize the node.
optionsescapeExtraCharacters?: RegExpExtra characters can be added for escaping. This is passed\ndirectly to String.replace(), and the matching characters are\npreceded by a backslash.
\nnodes: Object<fn(state: MarkdownSerializerState, node: Node, parent: Node, index: number)>The node serializer functions for this serializer.
\nmarks: Object<Object>The mark serializer info.
\noptions: ObjectescapeExtraCharacters?: RegExpExtra characters can be added for escaping. This is passed\ndirectly to String.replace(), and the matching characters are\npreceded by a backslash.
\nserialize(content: Node, options?: Object = {}) → stringSerialize the content of the given node to\nCommonMark.
\noptionstightLists?: booleanWhether to render lists in a tight style. This can be overridden\non a node level by specifying a tight attribute on the node.\nDefaults to false.
\nclass\n MarkdownSerializerStateThis is an object used to track state and expose\nmethods related to markdown serialization. Instances are passed to\nnode and mark serialization methods (see toMarkdown).
options: {tightLists?: boolean, escapeExtraCharacters?: RegExp}The options passed to the serializer.
\nwrapBlock(delim: string, firstDelim: string, node: Node, f: fn())Render a block, prefixing each line with delim, and the first\nline in firstDelim. node should be the node that is closed at\nthe end of the block, and f is a function that renders the\ncontent of the block.
ensureNewLine()Ensure the current content ends with a newline.
\nwrite(content?: string)Prepare the state for writing output (closing closed paragraphs,\nadding delimiters, and so on), and then optionally add content\n(unescaped) to the output.
\ncloseBlock(node: Node)Close the block for the given node.
\ntext(text: string, escape?: boolean = true)Add the given text to the document. When escape is not false,\nit will be escaped.
render(node: Node, parent: Node, index: number)Render the given node as a block.
\nrenderContent(parent: Node)Render the contents of parent as block nodes.
renderInline(parent: Node)Render the contents of parent as inline content.
renderList(node: Node, delim: string, firstDelim: fn(index: number) → string)Render a node's content as a list. delim should be the extra\nindentation added to all lines except the first in an item,\nfirstDelim is a function going from an item index to a\ndelimiter for the first line of the item.
esc(str: string, startOfLine?: boolean = false) → stringEscape the given string so that it can safely appear in Markdown\ncontent. If startOfLine is true, also escape characters that\nhave special meaning only at the start of the line.
repeat(str: string, n: number) → stringRepeat the given string n times.
markString(mark: Mark, open: boolean, parent: Node, index: number) → stringGet the markdown string for a given opening or closing mark.
\ngetEnclosingWhitespace(text: string) → {leading?: string, trailing?: string}Get leading and trailing whitespace from a string. Values of\nleading or trailing property of the return object will be undefined\nif there is no match.
\ndefaultMarkdownSerializer: MarkdownSerializerA serializer for the basic schema.
\n