Make block-level markdown a Markup Shorthands option

This will be enabled by HTML for a slight speed improvement, and not
having to carefully escape/indent certain things in the initial
conversion. We might later want to turn it on again.

Author: foolip

bikeshed/Spec.py

@@ -228,14 +228,16 @@ def assembleDocument(self) -> Spec:
         # Deal with further <pre> blocks, and markdown
         self.lines = datablocks.transformDataBlocks(self, self.lines)
 
-        markdownFeatures: set[str] = {"headings"}
-        self.lines = markdown.parse(
-            self.lines,
-            self.md.indent,
-            opaqueElements=self.md.opaqueElements,
-            blockElements=self.md.blockElements,
-            features=markdownFeatures,
-        )
+        parseConfig = h.ParseConfig.fromSpec(self)
+        if parseConfig.markdownBlock:
+            markdownFeatures: set[str] = {"headings"}
+            self.lines = markdown.parse(
+                self.lines,
+                self.md.indent,
+                opaqueElements=self.md.opaqueElements,
+                blockElements=self.md.blockElements,
+                features=markdownFeatures,
+            )
 
         self.refs.setSpecData(self)
 

bikeshed/h/parser/parser.py

@@ -225,7 +225,7 @@ def parseNode(
         el, i, _ = parseFencedCodeBlock(s, start)
         if el is not None:
             return Ok(el, i)
-    if s.config.markdown:
+    if s.config.markdownInline:
         if first2 == r"\`":
             node = RawText.fromStream(s, start, start + 2, "`")
             return Ok(node, start + 2)
@@ -378,7 +378,7 @@ def parseNode(
             biblioRes = parseAutolinkBiblioSection(s, start)
             if isOk(biblioRes):
                 return biblioRes
-    if s.config.markdown and not inOpaque:
+    if s.config.markdownInline and not inOpaque:
         if first2 == "\\[":
             node = RawText.fromStream(s, start, start + 2, "[")
             return Ok(node, start + 2)

bikeshed/h/parser/stream.py

@@ -23,7 +23,8 @@ class ParseConfig:
     header: bool = False
     idl: bool = False
     macrosInAutolinks: bool = False
-    markdown: bool = False
+    markdownBlock: bool = False
+    markdownInline: bool = False
     markdownEscapes: bool = False
     markup: bool = False
     repositoryLinks: bool = False
@@ -42,7 +43,8 @@ def fromSpec(doc: t.SpecT, context: str | None = None) -> ParseConfig:
             header="http" in doc.md.markupShorthands,
             idl="idl" in doc.md.markupShorthands,
             macrosInAutolinks="macros-in-autolinks" in doc.md.markupShorthands,
-            markdown="markdown" in doc.md.markupShorthands,
+            markdownBlock="markdown-block" in doc.md.markupShorthands,
+            markdownInline="markdown-inline" in doc.md.markupShorthands,
             markdownEscapes="markdown-escapes" in doc.md.markupShorthands,
             markup="markup" in doc.md.markupShorthands,
             repositoryLinks="repository-links" in doc.md.markupShorthands,

bikeshed/metadata.py

@@ -109,7 +109,18 @@ def __init__(self) -> None:
         self.mailingList: str | None = None
         self.mailingListArchives: str | None = None
         self.markupShorthands: config.BoolSet = config.BoolSet(
-            ["css", "dfn", "biblio", "markup", "http", "idl", "cddl", "algorithm", "repository-links"],
+            [
+                "css",
+                "dfn",
+                "biblio",
+                "markdown-block",
+                "markup",
+                "http",
+                "idl",
+                "cddl",
+                "algorithm",
+                "repository-links",
+            ],
         )
         self.maxToCDepth: int | float | None = float("inf")
         self.metadataInclude: config.BoolSet = config.BoolSet(default=True)
@@ -760,7 +771,7 @@ def parseLinkedText(key: str, val: str, lineNum: str | int | None) -> list[tuple
 def parseMarkupShorthands(key: str, val: str, lineNum: str | int | None) -> config.BoolSet:
     # Format is comma-separated list of shorthand category followed by boolean.
     # Output is a boolset of the shorthand categories.
-    # TODO: Just call parseBoolistList instead
+    # TODO: Just call parseBoolishList instead
     vals = [v.strip() for v in val.lower().split(",")]
     ret = config.BoolSet(default=False)
     validCategories = frozenset(
@@ -773,7 +784,8 @@ def parseMarkupShorthands(key: str, val: str, lineNum: str | int | None) -> conf
             "http",
             "idl",
             "macros-in-autolinks",
-            "markdown",
+            "markdown-block",
+            "markdown-inline",
             "markdown-escapes",
             "markup",
             "repository-links",
@@ -788,7 +800,13 @@ def parseMarkupShorthands(key: str, val: str, lineNum: str | int | None) -> conf
             )
             continue
         name, boolstring = pieces
-        if name not in validCategories:
+        # markdown is an alias for markdown-inline.
+        # TODO: convert all specs to use markdown-inline, and then turn markdown
+        # into a shorthand for markdown-*.
+        if name == "markdown":
+            name = "markdown-inline"
+            assert name in validCategories
+        elif name not in validCategories:
             m.die(f"Unknown Markup Shorthand category '{name}'.", lineNum=lineNum)
             continue
         onoff = boolish(boolstring)