summaryrefslogtreecommitdiffstats
path: root/markdown_it/presets
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:24:24 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:24:24 +0000
commit12e8343068b906f8b2afddc5569968a8a91fa5b0 (patch)
tree75cc5e05a4392ea0292251898f992a15a16b172b /markdown_it/presets
parentInitial commit. (diff)
downloadmarkdown-it-py-12e8343068b906f8b2afddc5569968a8a91fa5b0.tar.xz
markdown-it-py-12e8343068b906f8b2afddc5569968a8a91fa5b0.zip
Adding upstream version 2.1.0.upstream/2.1.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'markdown_it/presets')
-rw-r--r--markdown_it/presets/__init__.py27
-rw-r--r--markdown_it/presets/commonmark.py73
-rw-r--r--markdown_it/presets/default.py34
-rw-r--r--markdown_it/presets/zero.py39
4 files changed, 173 insertions, 0 deletions
diff --git a/markdown_it/presets/__init__.py b/markdown_it/presets/__init__.py
new file mode 100644
index 0000000..16f10e5
--- /dev/null
+++ b/markdown_it/presets/__init__.py
@@ -0,0 +1,27 @@
+__all__ = ("commonmark", "default", "zero", "js_default", "gfm_like")
+
+from . import commonmark, default, zero
+
+js_default = default
+
+
+class gfm_like:
+ """GitHub Flavoured Markdown (GFM) like.
+
+ This adds the linkify, table and strikethrough components to CommmonMark.
+
+ Note, it lacks task-list items and raw HTML filtering,
+ to meet the the full GFM specification
+ (see https://github.github.com/gfm/#autolinks-extension-).
+ """
+
+ @staticmethod
+ def make():
+ config = commonmark.make()
+ config["components"]["core"]["rules"].append("linkify")
+ config["components"]["block"]["rules"].append("table")
+ config["components"]["inline"]["rules"].append("strikethrough")
+ config["components"]["inline"]["rules2"].append("strikethrough")
+ config["options"]["linkify"] = True
+ config["options"]["html"] = True
+ return config
diff --git a/markdown_it/presets/commonmark.py b/markdown_it/presets/commonmark.py
new file mode 100644
index 0000000..e44b66b
--- /dev/null
+++ b/markdown_it/presets/commonmark.py
@@ -0,0 +1,73 @@
+"""Commonmark default options.
+
+This differs to presets.default,
+primarily in that it allows HTML and does not enable components:
+
+- block: table
+- inline: strikethrough
+"""
+
+
+def make():
+ return {
+ "options": {
+ "maxNesting": 20, # Internal protection, recursion limit
+ "html": True, # Enable HTML tags in source,
+ # this is just a shorthand for .enable(["html_inline", "html_block"])
+ # used by the linkify rule:
+ "linkify": False, # autoconvert URL-like texts to links
+ # used by the replacements and smartquotes rules
+ # Enable some language-neutral replacements + quotes beautification
+ "typographer": False,
+ # used by the smartquotes rule:
+ # 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", # /* “”‘’ */
+ # Renderer specific; these options are used directly in the HTML renderer
+ "xhtmlOut": True, # Use '/' to close single tags (<br />)
+ "breaks": False, # Convert '\n' in paragraphs into <br>
+ "langPrefix": "language-", # CSS language prefix for fenced blocks
+ # Highlighter function. Should return escaped HTML,
+ # or '' if the source string is not changed and should be escaped externally.
+ # If result starts with <pre... internal wrapper is skipped.
+ #
+ # function (/*str, lang, attrs*/) { return ''; }
+ #
+ "highlight": None,
+ },
+ "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"],
+ },
+ },
+ }
diff --git a/markdown_it/presets/default.py b/markdown_it/presets/default.py
new file mode 100644
index 0000000..59f4855
--- /dev/null
+++ b/markdown_it/presets/default.py
@@ -0,0 +1,34 @@
+"""markdown-it default options."""
+
+
+def make():
+ return {
+ "options": {
+ "maxNesting": 100, # Internal protection, recursion limit
+ "html": False, # Enable HTML tags in source
+ # this is just a shorthand for .disable(["html_inline", "html_block"])
+ # used by the linkify rule:
+ "linkify": False, # autoconvert URL-like texts to links
+ # used by the replacements and smartquotes rules:
+ # Enable some language-neutral replacements + quotes beautification
+ "typographer": False,
+ # used by the smartquotes rule:
+ # 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", # /* “”‘’ */
+ # Renderer specific; these options are used directly in the HTML renderer
+ "xhtmlOut": False, # Use '/' to close single tags (<br />)
+ "breaks": False, # Convert '\n' in paragraphs into <br>
+ "langPrefix": "language-", # CSS language prefix for fenced blocks
+ # Highlighter function. Should return escaped HTML,
+ # or '' if the source string is not changed and should be escaped externally.
+ # If result starts with <pre... internal wrapper is skipped.
+ #
+ # function (/*str, lang, attrs*/) { return ''; }
+ #
+ "highlight": None,
+ },
+ "components": {"core": {}, "block": {}, "inline": {}},
+ }
diff --git a/markdown_it/presets/zero.py b/markdown_it/presets/zero.py
new file mode 100644
index 0000000..af1d9c7
--- /dev/null
+++ b/markdown_it/presets/zero.py
@@ -0,0 +1,39 @@
+"""
+"Zero" preset, with nothing enabled. Useful for manual configuring of simple
+modes. For example, to parse bold/italic only.
+"""
+
+
+def make():
+ return {
+ "options": {
+ "maxNesting": 20, # Internal protection, recursion limit
+ "html": False, # Enable HTML tags in source
+ # this is just a shorthand for .disable(["html_inline", "html_block"])
+ # used by the linkify rule:
+ "linkify": False, # autoconvert URL-like texts to links
+ # used by the replacements and smartquotes rules:
+ # Enable some language-neutral replacements + quotes beautification
+ "typographer": False,
+ # used by the smartquotes rule:
+ # 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", # /* “”‘’ */
+ # Renderer specific; these options are used directly in the HTML renderer
+ "xhtmlOut": False, # Use '/' to close single tags (<br />)
+ "breaks": False, # Convert '\n' in paragraphs into <br>
+ "langPrefix": "language-", # CSS language prefix for fenced blocks
+ # Highlighter function. Should return escaped HTML,
+ # or '' if the source string is not changed and should be escaped externally.
+ # If result starts with <pre... internal wrapper is skipped.
+ # function (/*str, lang, attrs*/) { return ''; }
+ "highlight": None,
+ },
+ "components": {
+ "core": {"rules": ["normalize", "block", "inline"]},
+ "block": {"rules": ["paragraph"]},
+ "inline": {"rules": ["text"], "rules2": ["balance_pairs", "text_collapse"]},
+ },
+ }