Editor wikimarkup transformer

Examples

Typescript ❤️

Wiki markup transformer for JIRA and Confluence

Install

yarn add @atlaskit/editor-wikimarkup-transformer

npm

@atlaskit/editor-wikimarkup-transformer

Source

Bitbucket

Bundle

unpkg.com

Changelog

Latest

11.15.0

Minor Changes

#120472 73c800ab5f2fc - ED-26766 update adf-schema from 47.2.1 to 47.6.0 and adf-schema-json from 1.27.0 to 1.31.0

Patch Changes

Updated dependencies

Note: This component is designed for internal Atlassian development.

External contributors will be able to use this component but will not be able to submit issues.

This package provides a transformer for ProseMirror Node <-> Wikimarkup conversion.

Usage

Use the component in your React app as follows to encode ProseMirror node to Wikimarkup:

import { WikiMarkupTransformer } from '@atlaskit/editor-wikimarkup-transformer';

  const transformer = new WikiMarkupTransformer(schema);
  const wikimarkupString = transformer.encode(pmNode); // A Wikimarkup string representing the Prosemirror node output

Use the component in your React app as follows to parse Wikimarkup to ProseMirror node:

import { WikiMarkupTransformer } from '@atlaskit/editor-wikimarkup-transformer';

  const transformer = new WikiMarkupTransformer(schema);
  const pmNode = transformer.parse(wikiMarkup); // A prosemirror node is output

ADF to Wikimarkup

Editor

Output: