| hi |
| hi |
okay.
``` -------------------------------- ### Ordered list with zero start number Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Demonstrates that an ordered list can start with '0'. ```markdown 0. ok ``` -------------------------------- ### Empty List Item at Start of List Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html A list can start with an empty list item. ```markdown * . ``` -------------------------------- ### Install pre-commit for code style enforcement Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/contributing.md Installs the pre-commit package to ensure code style is met before commits are submitted. ```shell >> cd markdown-it-py >> pre-commit install ``` -------------------------------- ### HTML Block Rendering Example 2 Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Illustrates a basic HTML block starting with \`| hi |
okay.
``` -------------------------------- ### Creating a Markdown-It Plugin Source: https://github.com/executablebooks/markdown-it-py/blob/master/AGENTS.md Example of a plugin function that receives a MarkdownIt instance and options. It demonstrates how to add new parsing rules and render rules. ```python def my_plugin(md: MarkdownIt, **options): """My custom plugin.""" # Add rules md.block.ruler.before("fence", "my_block_rule", my_block_rule) md.inline.ruler.after("emphasis", "my_inline_rule", my_inline_rule) # Add render rules md.add_render_rule("my_token_type", render_my_token) ``` -------------------------------- ### Creating a Syntax Tree Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md Example of converting a token stream into a syntax tree, collapsing opening/closing tokens and containing children. ```python from markdown_it.tree import SyntaxTreeNode md = MarkdownIt("commonmark") tokens = md.parse(""" # Header Here's some text and an image  1. a **list** > a *quote*""") node = SyntaxTreeNode(tokens) print(node.pretty(indent=2, show_text=True)) ``` -------------------------------- ### URI Autolink Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Demonstrates a basic URI autolink. Ensure the URI is enclosed in angle brackets. ```markdown  &x; &#; &#x; � &#abcdef0; &ThisIsNotDefined; &hi?;
``` -------------------------------- ### Plugins supporting multiple render types Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md This example shows how plugins can support multiple render types using the '__output__' attribute. ```python from markdown_it.renderer import RendererHTML class MyRenderer1(RendererHTML): __output__ = "html1" class MyRenderer2(RendererHTML): __output__ = "html2" def plugin(md): def render_em_open1(self, tokens, idx, options, env): return '' def render_em_open2(self, tokens, idx, options, env): return '' md.add_render_rule("em_open", render_em_open1, fmt="html1") md.add_render_rule("em_open", render_em_open2, fmt="html2") md = MarkdownIt("commonmark", renderer_cls=MyRenderer1).use(plugin) print(md.render("*a*")) md = MarkdownIt("commonmark", renderer_cls=MyRenderer2).use(plugin) print(md.render("*a*")) ``` -------------------------------- ### Tab Expansion Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/rawtabs.md Demonstrates how markdown-it-py handles tab characters. Ensure tabs are not replaced with spaces for correct rendering. ```text 1 4444 22 333 333 22 4444 1 ``` ```text tab-indented line space-indented line tab-indented line ``` ```text a lot of spaces in between here ``` ```text a lot of tabs in between here ``` -------------------------------- ### AsciiDoc List Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html An example of a complex list structure in AsciiDoc, including nested lists and continuation paragraphs. ```asciidoc 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~/tmp ................. + List item continued with a third paragraph. 2. List item two continued with an open block. + -- This paragraph is part of the preceding list item. a. This list is nested and does not require explicit item continuation. + This paragraph is part of the preceding list item. b. List item b. This paragraph belongs to item two of the outer list. -- ``` -------------------------------- ### Subclassing the renderer Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md This example demonstrates subclassing the RendererHTML class to add custom rendering logic. ```python from markdown_it.renderer import RendererHTML class MyRenderer(RendererHTML): def em_open(self, tokens, idx, options, env): return '' md = MarkdownIt("commonmark", renderer_cls=MyRenderer) md.render("*a*") ``` -------------------------------- ### Type Annotation Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/AGENTS.md Example of using complete type annotations for function signatures as per project best practices. Ensure mypy is used for strict type checking. ```python from __future__ import annotations from typing import Sequence def parse_blocks( state: StateBlock, start_line: int, end_line: int, silent: bool = False ) -> bool: """Parse block-level content. :param state: The parser state object :param start_line: Starting line number :param end_line: Ending line number :param silent: If True, only validate without generating tokens :return: True if parsing succeeded """ ... ``` -------------------------------- ### Run all tests with Tox Source: https://github.com/executablebooks/markdown-it-py/blob/master/AGENTS.md Execute all defined test suites using Tox. Ensure Tox is installed and configured. ```bash tox ``` -------------------------------- ### AsciiDoc List Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Example of a complex list structure in AsciiDoc, including nested lists and indented blocks. ```asciidoc 1. List item one. + List item one continued with a second paragraph followed by an Indented block. + ................. $ ls *.sh $ mv *.sh ~\/tmp ................. + List item continued with a third paragraph. 2. List item two continued with an open block. + -- This paragraph is part of the preceding list item. a. This list is nested and does not require explicit item continuation. + This paragraph is part of the preceding list item. b. List item b. This paragraph belongs to item two of the outer list. -- ``` -------------------------------- ### HTML Output for Four-Space Rule Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Shows the HTML output generated by the four-space rule for the preceding Markdown example, highlighting the separation of list items and paragraphs. ```htmlbar
okay
``` -------------------------------- ### Code Block with Info String (Ruby) Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html Provides an example of a code block with an info string specifying the language as Ruby. ```ruby ```ruby def foo(x) return 3 end ``` .def foo(x)
return 3
end
foo
``` -------------------------------- ### Get all available parsing rules Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md Retrieves and pretty-prints all available parsing rules for the MarkdownIt parser. ```python pprint(md.get_all_rules()) ``` -------------------------------- ### Build documentation (clean) with Tox Source: https://github.com/executablebooks/markdown-it-py/blob/master/AGENTS.md Perform a clean build of the project documentation using the 'docs-clean' Tox environment. This ensures no stale artifacts affect the build. ```bash tox -e docs-clean ``` -------------------------------- ### Markdown to HTML: Basic List Item Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/spec.md Demonstrates how a markdown list item with a paragraph, indented code, and a block quote is converted to HTML. ```markdown ```````````````````````````````` example A paragraph with two lines. indented code > A block quote. . ``` ```htmlA paragraph with two lines.
indented code
``` -------------------------------- ### Build documentation (incremental) with Tox Source: https://github.com/executablebooks/markdown-it-py/blob/master/AGENTS.md Perform an incremental build of the project documentation using the 'docs-update' Tox environment. This is faster for iterative documentation changes. ```bash tox -e docs-update ``` -------------------------------- ### Comment Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html Illustrates how HTML comments are parsed. Content following a comment block is treated as CommonMark. ```markdown *bar* *baz* . *bar*A block quote.
baz
``` -------------------------------- ### Tilde Code Fence Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Illustrates the use of tilde characters for code fences, including those with internal spaces. ```markdown ~~~~~~ aaa ~~~ ~~ . ``` ```htmlaaa
~~~ ~~
okay
``` -------------------------------- ### Invalid Ordered List Start Number (10 Digits) Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/spec.md An ordered list with a start number of ten digits is not parsed as a list and is rendered as plain text. ```markdown 1234567890. not ok ``` ```html1234567890. not ok
``` -------------------------------- ### Render Basic Code Block Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_port/fixtures/commonmark_spec.md A simple example of a standard markdown code block. It shows basic text rendering within the code block. ```markdown foo bar ``` -------------------------------- ### Command-line Usage for markdown-it-py Source: https://github.com/executablebooks/markdown-it-py/blob/master/README.md Render markdown to HTML from the command line. Supports reading from standard input or specified files, and provides help and version flags. ```console usage: markdown-it [-h] [-v] [--stdin|filenames [filenames ...]] Parse one or more markdown files, convert each to HTML, and print to stdout positional arguments: --stdin read source Markdown file from standard input filenames specify an optional list of files to convert optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit Interactive: $ markdown-it markdown-it-py [version 0.0.0] (interactive) Type Ctrl-D to complete input, or Ctrl-C to exit. >>> # Example ... > markdown *input* ...Batch: $ markdown-it README.md README.footer.md > index.html ``` -------------------------------- ### List Interrupting Paragraph - Potential Unintended List Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html Shows a scenario where a numeral '1' starting a line within a paragraph can be interpreted as the start of a list, interrupting the paragraph. This highlights a potential for unintended list parsing. ```markdown The number of windows in my house is 1. The number of doors is 6. . ``` ```htmlmarkdown input
The number of windows in my house is
two
``` -------------------------------- ### Basic Open Tags Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Demonstrates the parsing of simple HTML open tags with various tag names. ```markdown``` -------------------------------- ### Hexadecimal Numeric Character References Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/spec.md Illustrates hexadecimal numeric character references, parsed as their corresponding Unicode characters using hexadecimal notation. ```html " ആ ಫ . ``` ```html
one
two
" ആ ಫ
``` -------------------------------- ### Autolink Example Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/spec.md When angle brackets enclose a URL-like string without backticks, it is parsed as an autolink. ```markdownfoobar
single and double
okay
``` -------------------------------- ### Load and use external plugins Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/plugins.md Illustrates how to load and use external plugins from the 'mdit-py-plugins' package using the use() method. ```python from markdown_it import MarkdownIt from mdit_py_plugins import plugin1, plugin2 md = MarkdownIt().use(plugin1, keyword=value).use(plugin2, keyword=value) html_string = md.render("some *Markdown*") ``` -------------------------------- ### Enable specific rules and render markdown Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md Enables the 'list' and 'emphasis' rules and then renders a markdown string. ```python md.enable(["list", "emphasis"]) md.render("- __*emphasise this*__") ``` -------------------------------- ### Thematic Breaks in Markdown Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/spec.md Demonstrates how consecutive thematic breaks are rendered. Requires no special setup. ```markdown --- --- ``` ```html</a href="foo">
``` -------------------------------- ### Build documentation with strict checks Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/contributing.md Performs a clean build of the documentation with strict HTML validation. ```shell >> cd markdown-it-py/docs >> make clean >> make html-strict ``` -------------------------------- ### Closing HTML Tags Source: https://github.com/executablebooks/markdown-it-py/blob/master/benchmarking/samples/spec.md Provides examples of valid closing HTML tags, including those with optional whitespace. ```markdown . ``` -------------------------------- ### Parsing to Token Stream Source: https://github.com/executablebooks/markdown-it-py/blob/master/docs/using.md Demonstrates parsing markdown text into a flat token stream and inspecting token types and nesting. ```python md = MarkdownIt("commonmark") tokens = md.parse(""" Here's some *text* 1. a list > a *quote*""") [(t.type, t.nesting) for t in tokens] ``` -------------------------------- ### Empty Code Block Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_port/fixtures/commonmark_spec.md An example of an empty code block. This can be used to test parser behavior with no content. ```plaintext ``` -------------------------------- ### Pre Tag Example (Type 1) Source: https://github.com/executablebooks/markdown-it-py/blob/master/tests/test_cmark_spec/test_spec/test_file.html Demonstrates a