Class: MarkdownIt::Presets::Commonmark

Inherits:
Object
  • Object
show all
Defined in:
lib/motion-markdown-it/presets/commonmark.rb

Class Method Summary collapse

Class Method Details

.options ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/motion-markdown-it/presets/commonmark.rb', line 6

def self.options
  {
    options: {
      html:         true,         # Enable HTML tags in source
      xhtmlOut:     true,         # Use '/' to close single tags (<br />)
      breaks:       false,        # Convert '\n' in paragraphs into <br>
      langPrefix:   'language-',  # CSS language prefix for fenced blocks
      linkify:      false,        # autoconvert URL-like texts to links

      # Enable some language-neutral replacements + quotes beautification
      typographer:  false,

      # Double + single quotes replacement pairs, when typographer enabled,
      # and smartquotes on. Could be either a String or an Array.
      #
      # For example, you can use '«»„“' for Russian, '„“‚‘' for German,
      # and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
      quotes: "\u201c\u201d\u2018\u2019", # “”‘’

      # Highlighter function. Should return escaped HTML,
      # or '' if the source string is not changed and should be escaped externaly.
      # If result starts with <pre... internal wrapper is skipped.
      #
      # function (/*str, lang*/) { return ''; }
      #
      highlight: nil,

      maxNesting:   20            # Internal protection, recursion limit
    },

    components: {

      core: {
        rules: [
          'normalize',
          'block',
          'inline'
        ]
      },

      block: {
        rules: [
          'blockquote',
          'code',
          'fence',
          'heading',
          'hr',
          'html_block',
          'lheading',
          'list',
          'reference',
          'paragraph'
        ]
      },

      inline: {
        rules: [
          'autolink',
          'backticks',
          'emphasis',
          'entity',
          'escape',
          'html_inline',
          'image',
          'link',
          'newline',
          'text'
        ],
        rules2: [
          'balance_pairs',
          'emphasis',
          'text_collapse'
        ]
      }
    }
  }
end