Module: ProseMirror

Defined in:
lib/prose_mirror.rb,
lib/prose_mirror/mark.rb,
lib/prose_mirror/node.rb,
lib/prose_mirror/version.rb,
lib/prose_mirror/converter.rb,
lib/prose_mirror/serializers/markdown_serializer.rb

Overview

ProseMirror module serves as the namespace for all ProseMirror components

Defined Under Namespace

Modules: Serializers Classes: Converter, Mark, Node

Constant Summary collapse

VERSION = 
"0.1.8"

Class Method Summary collapse

Class Method Details

.parse(json_string) ⇒ ProseMirror::Node

Convert a JSON ProseMirror document to a ProseMirror::Node tree

Parameters:

  • json_string (String) —

    The JSON string representation of a ProseMirror document

Returns:



19
20
21
 
# File 'lib/prose_mirror.rb', line 19

def self.parse(json_string)
  Converter.from_json(json_string)
end

.to_markdown(node, options = {}) ⇒ String

Convert a ProseMirror::Node to Markdown

Parameters:

  • node (ProseMirror::Node) —

    The root node of the document

  • options (Hash) (defaults to: {}) —

    Optional serialization options

Returns:

  • (String) —

    The markdown representation



27
28
29
30
31
32
33
34
 
# File 'lib/prose_mirror.rb', line 27

def self.to_markdown(node, options = {})
  serializer = Serializers::MarkdownSerializer.new(
    Serializers::MarkdownSerializer::DEFAULT_NODE_SERIALIZERS.dup,
    Serializers::MarkdownSerializer::DEFAULT_MARK_SERIALIZERS.dup,
    options
  )
  serializer.serialize(node)
end