|
| 1 | +"""Material Definition Lists. |
| 2 | +
|
| 3 | +Based on |
| 4 | +[mdformat-deflist](https://github.com/executablebooks/mdformat-deflist/blob/bbcf9ed4f80847db58b6f932ed95e2c7a6c49ae5/mdformat_deflist/plugin.py), |
| 5 | +but modified for mkdocs-material conventions. |
| 6 | +
|
| 7 | +Example: |
| 8 | +```md |
| 9 | +`Lorem ipsum dolor sit amet` |
| 10 | +
|
| 11 | +: Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus |
| 12 | + tellus non sem sollicitudin, quis rutrum leo facilisis. |
| 13 | +
|
| 14 | +`Cras arcu libero` |
| 15 | +
|
| 16 | +: Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin |
| 17 | + ut eros sed sapien ullamcorper consequat. Nunc ligula ante. |
| 18 | +
|
| 19 | + Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. |
| 20 | + Nam vulputate tincidunt fringilla. |
| 21 | + Nullam dignissim ultrices urna non auctor. |
| 22 | +``` |
| 23 | +
|
| 24 | +Docs: |
| 25 | +<https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists> |
| 26 | +
|
| 27 | +""" |
| 28 | + |
| 29 | +from __future__ import annotations |
| 30 | + |
| 31 | +from typing import TYPE_CHECKING |
| 32 | + |
| 33 | +from markdown_it import MarkdownIt |
| 34 | +from mdit_py_plugins.deflist import deflist_plugin |
| 35 | + |
| 36 | +if TYPE_CHECKING: |
| 37 | + from markdown_it import MarkdownIt |
| 38 | + from mdformat.renderer import RenderContext, RenderTreeNode |
| 39 | + from mdformat.renderer.typing import Render |
| 40 | + |
| 41 | + |
| 42 | +def material_deflist_plugin(md: MarkdownIt) -> None: |
| 43 | + """Add mkdocs-material definition list support to markdown-it parser.""" |
| 44 | + md.use(deflist_plugin) |
| 45 | + |
| 46 | + |
| 47 | +def make_render_children(separator: str) -> Render: |
| 48 | + """Create a renderer that joins child nodes with a separator.""" |
| 49 | + |
| 50 | + def render_children( |
| 51 | + node: RenderTreeNode, |
| 52 | + context: RenderContext, |
| 53 | + ) -> str: |
| 54 | + return separator.join(child.render(context) for child in node.children) |
| 55 | + |
| 56 | + return render_children |
| 57 | + |
| 58 | + |
| 59 | +def render_material_definition_list( |
| 60 | + node: RenderTreeNode, |
| 61 | + context: RenderContext, |
| 62 | +) -> str: |
| 63 | + """Render Material Definition List.""" |
| 64 | + return make_render_children("\n")(node, context) |
| 65 | + |
| 66 | + |
| 67 | +def render_material_definition_term( |
| 68 | + node: RenderTreeNode, |
| 69 | + context: RenderContext, |
| 70 | +) -> str: |
| 71 | + """Render Material Definition Term.""" |
| 72 | + return make_render_children("\n")(node, context) |
| 73 | + |
| 74 | + |
| 75 | +def render_material_definition_body( |
| 76 | + node: RenderTreeNode, |
| 77 | + context: RenderContext, |
| 78 | +) -> str: |
| 79 | + """Render the definition body.""" |
| 80 | + tight_list = all( |
| 81 | + child.type != "paragraph" or child.hidden for child in node.children |
| 82 | + ) |
| 83 | + marker = ": " # FYI: increased for material |
| 84 | + indent_width = len(marker) |
| 85 | + context.env["indent_width"] += indent_width |
| 86 | + try: |
| 87 | + text = make_render_children("\n\n")(node, context) |
| 88 | + lines = text.splitlines() |
| 89 | + if not lines: |
| 90 | + return ":" |
| 91 | + indented_lines = [f"{marker}{lines[0]}"] + [ |
| 92 | + f"{' ' * indent_width}{line}" if line else "" for line in lines[1:] |
| 93 | + ] |
| 94 | + joined_lines = ("" if tight_list else "\n") + "\n".join(indented_lines) |
| 95 | + next_sibling = node.next_sibling |
| 96 | + return joined_lines + ( |
| 97 | + "\n" if (next_sibling and next_sibling.type == "dt") else "" |
| 98 | + ) |
| 99 | + finally: |
| 100 | + context.env["indent_width"] -= indent_width |
| 101 | + |
| 102 | + |
| 103 | +def escape_deflist( |
| 104 | + text: str, |
| 105 | + node: RenderTreeNode, # noqa: ARG001 |
| 106 | + context: RenderContext, # noqa: ARG001 |
| 107 | +) -> str: |
| 108 | + """Escape line starting ":" which would otherwise be parsed as a definition list.""" |
| 109 | + return "\n".join( |
| 110 | + "\\" + line if line.startswith(":") else line for line in text.split("\n") |
| 111 | + ) |
0 commit comments