multimark 0.3.2__tar.gz → 0.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {multimark-0.3.2 → multimark-0.5.0}/.github/workflows/ci.yml +35 -4
- {multimark-0.3.2 → multimark-0.5.0}/.github/workflows/pyodide.yml +1 -1
- {multimark-0.3.2 → multimark-0.5.0}/.github/workflows/test-build.yml +6 -0
- {multimark-0.3.2 → multimark-0.5.0}/CITATION.cff +1 -1
- {multimark-0.3.2 → multimark-0.5.0}/Makefile +5 -4
- {multimark-0.3.2/src/multimark.egg-info → multimark-0.5.0}/PKG-INFO +40 -9
- {multimark-0.3.2 → multimark-0.5.0}/README.md +38 -7
- {multimark-0.3.2 → multimark-0.5.0}/WHEELS.md +11 -5
- multimark-0.5.0/_freeze/reference/Options/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/cmark_version/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_commonmark/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_html/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_latex/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_man/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_plaintext/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/reference/markdown_to_xml/execute-results/html.json +12 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/gfm-extensions/execute-results/html.json +3 -3
- multimark-0.5.0/_freeze/user-guide/introduction/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/user-guide/options-and-flags/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/user-guide/output-formats/execute-results/html.json +12 -0
- multimark-0.5.0/_freeze/user-guide/parsing-and-ast/execute-results/html.json +12 -0
- {multimark-0.3.2 → multimark-0.5.0}/great-docs.yml +2 -1
- {multimark-0.3.2 → multimark-0.5.0}/index.qmd +4 -3
- {multimark-0.3.2 → multimark-0.5.0}/pyproject.toml +3 -3
- {multimark-0.3.2 → multimark-0.5.0}/skills/multimark/SKILL.md +5 -4
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/__init__.py +4 -0
- multimark-0.5.0/src/multimark/_batch.py +107 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/_build_cmark.py +27 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/_cli.py +11 -4
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/_cmark.py +139 -14
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/_node.py +27 -1
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/_parser.py +34 -1
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark/cmark.cffi.h +9 -0
- {multimark-0.3.2 → multimark-0.5.0/src/multimark.egg-info}/PKG-INFO +40 -9
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/SOURCES.txt +7 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/scm_file_list.json +7 -0
- multimark-0.5.0/src/multimark.egg-info/scm_version.json +8 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_ast.py +14 -0
- multimark-0.5.0/tests/test_batch.py +54 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_cli.py +14 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_errors.py +2 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_extensions.py +3 -1
- multimark-0.5.0/tests/test_math.py +256 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_package.py +2 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_param_combos.py +7 -3
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_parser.py +23 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_pathological.py +2 -0
- multimark-0.5.0/tests/test_plaintext.py +55 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_threads.py +25 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/autolink.c +3 -1
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/cmark-gfm-core-extensions.h +6 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/core-extensions.c +2 -0
- multimark-0.5.0/third_party/cmark-gfm/extensions/texmath.c +400 -0
- multimark-0.5.0/third_party/cmark-gfm/extensions/texmath.h +11 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/blocks.c +11 -4
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark-gfm-extension_api.h +9 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/commonmark.c +10 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/inlines.c +46 -19
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/inlines.h +1 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/node.h +6 -1
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/parser.h +5 -0
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/00-introduction.qmd +3 -2
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/03-gfm-extensions.qmd +72 -4
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/04-output-formats.qmd +63 -3
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/05-options-and-flags.qmd +6 -3
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/06-cli.qmd +23 -8
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/09-performance.qmd +1 -1
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/10-parsing-and-ast.qmd +18 -2
- multimark-0.3.2/_freeze/reference/Options/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/cmark_version/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/markdown_to_commonmark/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/markdown_to_html/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/markdown_to_latex/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/markdown_to_man/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/reference/markdown_to_xml/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/user-guide/introduction/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/user-guide/options-and-flags/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/user-guide/output-formats/execute-results/html.json +0 -12
- multimark-0.3.2/_freeze/user-guide/parsing-and-ast/execute-results/html.json +0 -12
- multimark-0.3.2/src/multimark.egg-info/scm_version.json +0 -8
- {multimark-0.3.2 → multimark-0.5.0}/.github/CODE_OF_CONDUCT.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/CONTRIBUTING.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/ISSUE_TEMPLATE/bug.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/ISSUE_TEMPLATE/feature.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/ISSUE_TEMPLATE/question.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/workflows/docs.yml +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.github/workflows/test-sdist.yml +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/.gitignore +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/LICENSE +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/ROADMAP.md +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/site_libs/clipboard/clipboard.min.js +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/installation/execute-results/html.json +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/performance/execute-results/html.json +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/quick-start/execute-results/html.json +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/recipes/execute-results/html.json +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/_freeze/user-guide/security/execute-results/html.json +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/assets/logo-dark.png +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/assets/logo-light.png +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/assets/logo.png +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/multimark/_binding.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/multimark/_binding.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/setup.cfg +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/setup.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/dependency_links.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/entry_points.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/requires.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/src/multimark.egg-info/top_level.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/conftest.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/fixtures/extensions.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/fixtures/regression.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/fixtures/smart_punct.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/fixtures/spec.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/spec_parser.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_commonmark.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_html.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_latex.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_man.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_regressions.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_spec_html.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_spec_renderers.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/tests/test_xml.py +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/CMakeLists.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/autolink.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/autolink.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/core-extensions.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/ext_scanners.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/ext_scanners.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/ext_scanners.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/ext_scanners.re +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/strikethrough.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/strikethrough.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/strikethrough.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/table.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/table.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/table.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tagfilter.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tagfilter.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tagfilter.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tasklist.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tasklist.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/extensions/tasklist.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/CMakeLists.txt +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/arena.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/arena.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/blocks.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/buffer.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/buffer.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/buffer.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/case_fold_switch.inc +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/chunk.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark-gfm.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark-gfm_export.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark-gfm_version.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark-gfm_version.h.in +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark_ctype.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark_ctype.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/cmark_ctype.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/commonmark.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/config.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/config.h.in +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/entities.inc +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/footnotes.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/footnotes.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/footnotes.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_href_e.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_href_e.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_html_e.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_html_e.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_html_u.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/houdini_html_u.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/html.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/html.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/html.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/inlines.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/iterator.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/iterator.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/iterator.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/latex.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/latex.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/libcmark-gfm.pc.in +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/linked_list.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/linked_list.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/main.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/man.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/man.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/map.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/map.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/map.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/node.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/node.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/plaintext.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/plaintext.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/plugin.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/plugin.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/plugin.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/references.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/references.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/references.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/registry.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/registry.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/registry.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/render.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/render.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/render.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/scanners.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/scanners.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/scanners.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/scanners.re +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/syntax_extension.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/syntax_extension.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/syntax_extension.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/utf8.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/utf8.h +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/utf8.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/xml.c +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/third_party/cmark-gfm/src/xml.o +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/01-installation.qmd +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/02-quick-start.qmd +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/07-security.qmd +0 -0
- {multimark-0.3.2 → multimark-0.5.0}/user_guide/08-recipes.qmd +0 -0
|
@@ -20,6 +20,13 @@ jobs:
|
|
|
20
20
|
matrix:
|
|
21
21
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
|
22
22
|
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
|
|
23
|
+
# setup-python has no 3.9 build for Ubuntu 26.04 (ubuntu-latest from Oct 2026)
|
|
24
|
+
exclude:
|
|
25
|
+
- os: ubuntu-latest
|
|
26
|
+
python-version: "3.9"
|
|
27
|
+
include:
|
|
28
|
+
- os: ubuntu-24.04
|
|
29
|
+
python-version: "3.9"
|
|
23
30
|
|
|
24
31
|
steps:
|
|
25
32
|
- uses: actions/checkout@v6
|
|
@@ -56,6 +63,12 @@ jobs:
|
|
|
56
63
|
with:
|
|
57
64
|
python-version: "3.12"
|
|
58
65
|
|
|
66
|
+
- name: Set up QEMU
|
|
67
|
+
if: runner.os == 'Linux'
|
|
68
|
+
uses: docker/setup-qemu-action@v3
|
|
69
|
+
with:
|
|
70
|
+
platforms: arm64
|
|
71
|
+
|
|
59
72
|
- name: Install cibuildwheel
|
|
60
73
|
run: pip install cibuildwheel==2.23.4
|
|
61
74
|
|
|
@@ -64,7 +77,7 @@ jobs:
|
|
|
64
77
|
|
|
65
78
|
- uses: actions/upload-artifact@v4
|
|
66
79
|
with:
|
|
67
|
-
name: wheels-${{ matrix.os }}
|
|
80
|
+
name: wheels-native-${{ matrix.os }}
|
|
68
81
|
path: ./wheelhouse/*.whl
|
|
69
82
|
|
|
70
83
|
build_pyodide:
|
|
@@ -78,13 +91,13 @@ jobs:
|
|
|
78
91
|
with:
|
|
79
92
|
fetch-depth: 0
|
|
80
93
|
|
|
81
|
-
- uses: pypa/cibuildwheel@
|
|
94
|
+
- uses: pypa/cibuildwheel@v4.2.1
|
|
82
95
|
env:
|
|
83
96
|
CIBW_PLATFORM: pyodide
|
|
84
97
|
|
|
85
98
|
- uses: actions/upload-artifact@v4
|
|
86
99
|
with:
|
|
87
|
-
name: pyodide
|
|
100
|
+
name: wheels-pyodide
|
|
88
101
|
path: wheelhouse/*.whl
|
|
89
102
|
|
|
90
103
|
build_sdist:
|
|
@@ -118,7 +131,7 @@ jobs:
|
|
|
118
131
|
steps:
|
|
119
132
|
- uses: actions/download-artifact@v4
|
|
120
133
|
with:
|
|
121
|
-
pattern: wheels-*
|
|
134
|
+
pattern: wheels-native-*
|
|
122
135
|
path: dist
|
|
123
136
|
merge-multiple: true
|
|
124
137
|
|
|
@@ -132,3 +145,21 @@ jobs:
|
|
|
132
145
|
user: __token__
|
|
133
146
|
password: ${{ secrets.PYPI_API_TOKEN }}
|
|
134
147
|
skip-existing: true
|
|
148
|
+
|
|
149
|
+
# Uploaded separately so a Pyodide failure can't block the native release.
|
|
150
|
+
publish_pyodide:
|
|
151
|
+
name: Publish Pyodide wheel to PyPI
|
|
152
|
+
needs: [publish, build_pyodide]
|
|
153
|
+
runs-on: ubuntu-latest
|
|
154
|
+
if: github.event_name == 'release'
|
|
155
|
+
steps:
|
|
156
|
+
- uses: actions/download-artifact@v4
|
|
157
|
+
with:
|
|
158
|
+
name: wheels-pyodide
|
|
159
|
+
path: dist
|
|
160
|
+
|
|
161
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
162
|
+
with:
|
|
163
|
+
user: __token__
|
|
164
|
+
password: ${{ secrets.PYPI_API_TOKEN }}
|
|
165
|
+
skip-existing: true
|
|
@@ -3,7 +3,7 @@ message: 'If you wish to cite the "nokap" package use:'
|
|
|
3
3
|
type: software
|
|
4
4
|
license: MIT
|
|
5
5
|
title: "multimark provides Python bindings to cmark and allows for CommonMark parsing and rendering (HTML, LaTeX, man, XML)"
|
|
6
|
-
version: "0.
|
|
6
|
+
version: "0.4.0"
|
|
7
7
|
abstract:
|
|
8
8
|
multimark provides Python bindings to cmark, enabling CommonMark parsing and rendering to various formats
|
|
9
9
|
including HTML, LaTeX, man, and XML. A CLI is also provided for command-line usage. The package is designed to be fast,
|
|
@@ -38,8 +38,8 @@ dist-wheel: clean ## builds native abi3 wheel using cibuildwheel
|
|
|
38
38
|
|
|
39
39
|
.PHONY: dist-pyodide
|
|
40
40
|
dist-pyodide: clean ## builds Pyodide/emscripten wheel (requires Linux or macOS)
|
|
41
|
-
pip install
|
|
42
|
-
|
|
41
|
+
pip install cibuildwheel==4.2.1
|
|
42
|
+
python -m cibuildwheel --platform pyodide --output-dir dist
|
|
43
43
|
ls -l dist
|
|
44
44
|
|
|
45
45
|
.PHONY: dist-sdist
|
|
@@ -50,8 +50,9 @@ dist-sdist: clean ## builds source distribution only
|
|
|
50
50
|
|
|
51
51
|
.PHONY: dist-all
|
|
52
52
|
dist-all: clean ## builds native wheel, Pyodide wheel, and sdist
|
|
53
|
-
pip install cibuildwheel==2.23.4
|
|
53
|
+
pip install cibuildwheel==2.23.4 build
|
|
54
54
|
python -m cibuildwheel --output-dir dist
|
|
55
|
-
|
|
55
|
+
pip install cibuildwheel==4.2.1
|
|
56
|
+
python -m cibuildwheel --platform pyodide --output-dir dist
|
|
56
57
|
python3 -m build --sdist --outdir dist
|
|
57
58
|
ls -l dist
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: multimark
|
|
3
|
-
Version: 0.
|
|
4
|
-
Summary: Python bindings to cmark: CommonMark parsing and rendering (HTML, LaTeX, man, XML)
|
|
3
|
+
Version: 0.5.0
|
|
4
|
+
Summary: Python bindings to cmark: CommonMark parsing and rendering (HTML, LaTeX, man, XML, CommonMark, plaintext)
|
|
5
5
|
Author: Rich Iannone
|
|
6
6
|
License-Expression: MIT AND BSD-2-Clause
|
|
7
7
|
Project-URL: Homepage, https://github.com/posit-dev/multimark
|
|
@@ -39,7 +39,7 @@ Dynamic: license-file
|
|
|
39
39
|
|
|
40
40
|
The **multimark** package has Python bindings to [cmark-gfm](https://github.com/github/cmark-gfm), the C reference implementation of [CommonMark](https://commonmark.org/) with GitHub Flavored Markdown extensions.
|
|
41
41
|
|
|
42
|
-
Renders Markdown to **HTML**, **LaTeX**, **groff man**, **XML**, and **
|
|
42
|
+
Renders Markdown to **HTML**, **LaTeX**, **groff man**, **XML**, **normalized CommonMark**, and **plain text**: all from a single, lightweight package.
|
|
43
43
|
|
|
44
44
|
## Installation
|
|
45
45
|
|
|
@@ -69,8 +69,21 @@ latex = markdown_to_latex("**Hello**, *world*!")
|
|
|
69
69
|
| `markdown_to_latex()` | LaTeX |
|
|
70
70
|
| `markdown_to_man()` | groff man page |
|
|
71
71
|
| `markdown_to_commonmark()` | Normalized CommonMark |
|
|
72
|
+
| `markdown_to_plaintext()` | Readable plain text |
|
|
72
73
|
| `markdown_to_xml()` | XML (AST representation) |
|
|
73
74
|
|
|
75
|
+
```python
|
|
76
|
+
from multimark import markdown_to_plaintext
|
|
77
|
+
|
|
78
|
+
markdown_to_plaintext("**Hello**, *world*!")
|
|
79
|
+
# 'Hello, world!\n'
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Plaintext output preserves list markers, code contents, and image descriptions,
|
|
83
|
+
but drops link destinations. GFM tables keep pipe syntax, task lists keep checkbox
|
|
84
|
+
markers, and strikethrough uses single tildes. Raw HTML blocks (including their
|
|
85
|
+
text) are omitted even with `unsafe=True`. Empty input returns `"\n"`.
|
|
86
|
+
|
|
74
87
|
## Options
|
|
75
88
|
|
|
76
89
|
Use named boolean keyword arguments for common settings:
|
|
@@ -90,7 +103,7 @@ markdown_to_html('<div>hi</div>', unsafe=True)
|
|
|
90
103
|
markdown_to_html('**Hello**', sourcepos=True)
|
|
91
104
|
# '<p data-sourcepos="1:1-1:9"><strong>Hello</strong></p>\n'
|
|
92
105
|
|
|
93
|
-
# Line wrapping (LaTeX, man, and
|
|
106
|
+
# Line wrapping (LaTeX, man, CommonMark, and plaintext renderers)
|
|
94
107
|
markdown_to_latex('**Hello**, *world*!', width=80)
|
|
95
108
|
# '\\textbf{Hello}, \\emph{world}!\n'
|
|
96
109
|
|
|
@@ -128,23 +141,41 @@ html = markdown_to_html(text, extensions=["table", "strikethrough", "autolink",
|
|
|
128
141
|
|
|
129
142
|
Available extensions: `table`, `strikethrough`, `autolink`, `tagfilter`, `tasklist`.
|
|
130
143
|
|
|
144
|
+
## TeX Math
|
|
145
|
+
|
|
146
|
+
The `math` extension (not part of GFM) recognizes `$...$` and `$$...$$` math with
|
|
147
|
+
Pandoc's delimiter rules, so dollar amounts like `$5` stay text. HTML output uses the
|
|
148
|
+
markup that MathJax and KaTeX look for:
|
|
149
|
+
|
|
150
|
+
```python
|
|
151
|
+
markdown_to_html("Euler: $e^{i\\pi} + 1 = 0$, costing $5", extensions=["math"])
|
|
152
|
+
# '<p>Euler: <span class="math inline">\\(e^{i\\pi} + 1 = 0\\)</span>, costing $5</p>\n'
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
LaTeX output uses `\(...\)` and `\[...\]`; the CommonMark, man, and plaintext renderers
|
|
156
|
+
keep the dollar delimiters.
|
|
157
|
+
|
|
131
158
|
## All Renderer Parameters
|
|
132
159
|
|
|
133
160
|
Every renderer accepts:
|
|
134
161
|
|
|
135
162
|
- **`text`**: Markdown string
|
|
136
163
|
- **`options`**: raw bitmask (default `0`)
|
|
137
|
-
- **`extensions`**: list of
|
|
164
|
+
- **`extensions`**: list of extension names (default `()`)
|
|
138
165
|
- **`smart`**: smart punctuation
|
|
139
166
|
- **`hardbreaks`**: render soft breaks as `<br>`
|
|
140
|
-
- **`unsafe`**: allow raw HTML
|
|
167
|
+
- **`unsafe`**: allow raw HTML (no effect on plaintext output)
|
|
141
168
|
- **`normalize`**: consolidate adjacent text nodes
|
|
142
169
|
- **`footnotes`**: enable footnote syntax
|
|
143
170
|
|
|
144
171
|
Additional parameters:
|
|
145
172
|
|
|
146
173
|
- **`sourcepos`**: Source position attributes (HTML and XML only)
|
|
147
|
-
- **`width`**: Line wrap column (LaTeX, man, and
|
|
174
|
+
- **`width`**: Line wrap column (LaTeX, man, CommonMark, and plaintext only; `0` = no wrap)
|
|
175
|
+
|
|
176
|
+
For plaintext, `hardbreaks=True` disables width-based wrapping. With `width=0`,
|
|
177
|
+
soft line breaks are preserved; a positive width reflows them as spaces before
|
|
178
|
+
wrapping. Output whitespace and trailing newlines are retained.
|
|
148
179
|
|
|
149
180
|
## Why multimark?
|
|
150
181
|
|
|
@@ -153,14 +184,14 @@ Several Python packages wrap cmark or provide CommonMark parsing. Here's how the
|
|
|
153
184
|
| | **multimark** | **[cmarkgfm](https://github.com/theacodes/cmarkgfm)** | **[commonmark.py](https://github.com/readthedocs/commonmark.py)** |
|
|
154
185
|
|---|---|---|---|
|
|
155
186
|
| Engine | cmark-gfm (C, vendored) | cmark-gfm (C, vendored) | Pure Python |
|
|
156
|
-
| Output formats | HTML, LaTeX, man, XML, CommonMark | HTML only | HTML only |
|
|
187
|
+
| Output formats | HTML, LaTeX, man, XML, CommonMark, plaintext | HTML only | HTML only |
|
|
157
188
|
| GFM extensions | ✓ | ✓ | ✗ |
|
|
158
189
|
| Safe by default | ✓ | ✓ | ✗ |
|
|
159
190
|
| Convenience kwargs | `smart=True`, `unsafe=True`, etc. | Raw bitmask only | N/A |
|
|
160
191
|
| Performance | **Fastest** (14% faster than cmarkgfm) | Fast | ~31× slower |
|
|
161
192
|
| Maintained | Active (2026) | Active (2025) | Unmaintained (2019) |
|
|
162
193
|
|
|
163
|
-
multimark uses the same battle-tested C library as `cmarkgfm` but exposes all
|
|
194
|
+
multimark uses the same battle-tested C library as `cmarkgfm` but exposes all six of cmark's output formats (not just HTML). The API is designed around keyword arguments rather than opaque bitmasks, and unsafe content is blocked by default so the safe choice requires no extra configuration.
|
|
164
195
|
|
|
165
196
|
Thanks to extension pointer caching and reduced Python-side overhead, multimark is the **fastest Python Markdown-to-HTML library**. Take a look at the [benchmarks](https://posit-dev.github.io/multimark/user-guide/performance.html) for more detail on this.
|
|
166
197
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
The **multimark** package has Python bindings to [cmark-gfm](https://github.com/github/cmark-gfm), the C reference implementation of [CommonMark](https://commonmark.org/) with GitHub Flavored Markdown extensions.
|
|
13
13
|
|
|
14
|
-
Renders Markdown to **HTML**, **LaTeX**, **groff man**, **XML**, and **
|
|
14
|
+
Renders Markdown to **HTML**, **LaTeX**, **groff man**, **XML**, **normalized CommonMark**, and **plain text**: all from a single, lightweight package.
|
|
15
15
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
@@ -41,8 +41,21 @@ latex = markdown_to_latex("**Hello**, *world*!")
|
|
|
41
41
|
| `markdown_to_latex()` | LaTeX |
|
|
42
42
|
| `markdown_to_man()` | groff man page |
|
|
43
43
|
| `markdown_to_commonmark()` | Normalized CommonMark |
|
|
44
|
+
| `markdown_to_plaintext()` | Readable plain text |
|
|
44
45
|
| `markdown_to_xml()` | XML (AST representation) |
|
|
45
46
|
|
|
47
|
+
```python
|
|
48
|
+
from multimark import markdown_to_plaintext
|
|
49
|
+
|
|
50
|
+
markdown_to_plaintext("**Hello**, *world*!")
|
|
51
|
+
# 'Hello, world!\n'
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Plaintext output preserves list markers, code contents, and image descriptions,
|
|
55
|
+
but drops link destinations. GFM tables keep pipe syntax, task lists keep checkbox
|
|
56
|
+
markers, and strikethrough uses single tildes. Raw HTML blocks (including their
|
|
57
|
+
text) are omitted even with `unsafe=True`. Empty input returns `"\n"`.
|
|
58
|
+
|
|
46
59
|
## Options
|
|
47
60
|
|
|
48
61
|
Use named boolean keyword arguments for common settings:
|
|
@@ -62,7 +75,7 @@ markdown_to_html('<div>hi</div>', unsafe=True)
|
|
|
62
75
|
markdown_to_html('**Hello**', sourcepos=True)
|
|
63
76
|
# '<p data-sourcepos="1:1-1:9"><strong>Hello</strong></p>\n'
|
|
64
77
|
|
|
65
|
-
# Line wrapping (LaTeX, man, and
|
|
78
|
+
# Line wrapping (LaTeX, man, CommonMark, and plaintext renderers)
|
|
66
79
|
markdown_to_latex('**Hello**, *world*!', width=80)
|
|
67
80
|
# '\\textbf{Hello}, \\emph{world}!\n'
|
|
68
81
|
|
|
@@ -100,23 +113,41 @@ html = markdown_to_html(text, extensions=["table", "strikethrough", "autolink",
|
|
|
100
113
|
|
|
101
114
|
Available extensions: `table`, `strikethrough`, `autolink`, `tagfilter`, `tasklist`.
|
|
102
115
|
|
|
116
|
+
## TeX Math
|
|
117
|
+
|
|
118
|
+
The `math` extension (not part of GFM) recognizes `$...$` and `$$...$$` math with
|
|
119
|
+
Pandoc's delimiter rules, so dollar amounts like `$5` stay text. HTML output uses the
|
|
120
|
+
markup that MathJax and KaTeX look for:
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
markdown_to_html("Euler: $e^{i\\pi} + 1 = 0$, costing $5", extensions=["math"])
|
|
124
|
+
# '<p>Euler: <span class="math inline">\\(e^{i\\pi} + 1 = 0\\)</span>, costing $5</p>\n'
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
LaTeX output uses `\(...\)` and `\[...\]`; the CommonMark, man, and plaintext renderers
|
|
128
|
+
keep the dollar delimiters.
|
|
129
|
+
|
|
103
130
|
## All Renderer Parameters
|
|
104
131
|
|
|
105
132
|
Every renderer accepts:
|
|
106
133
|
|
|
107
134
|
- **`text`**: Markdown string
|
|
108
135
|
- **`options`**: raw bitmask (default `0`)
|
|
109
|
-
- **`extensions`**: list of
|
|
136
|
+
- **`extensions`**: list of extension names (default `()`)
|
|
110
137
|
- **`smart`**: smart punctuation
|
|
111
138
|
- **`hardbreaks`**: render soft breaks as `<br>`
|
|
112
|
-
- **`unsafe`**: allow raw HTML
|
|
139
|
+
- **`unsafe`**: allow raw HTML (no effect on plaintext output)
|
|
113
140
|
- **`normalize`**: consolidate adjacent text nodes
|
|
114
141
|
- **`footnotes`**: enable footnote syntax
|
|
115
142
|
|
|
116
143
|
Additional parameters:
|
|
117
144
|
|
|
118
145
|
- **`sourcepos`**: Source position attributes (HTML and XML only)
|
|
119
|
-
- **`width`**: Line wrap column (LaTeX, man, and
|
|
146
|
+
- **`width`**: Line wrap column (LaTeX, man, CommonMark, and plaintext only; `0` = no wrap)
|
|
147
|
+
|
|
148
|
+
For plaintext, `hardbreaks=True` disables width-based wrapping. With `width=0`,
|
|
149
|
+
soft line breaks are preserved; a positive width reflows them as spaces before
|
|
150
|
+
wrapping. Output whitespace and trailing newlines are retained.
|
|
120
151
|
|
|
121
152
|
## Why multimark?
|
|
122
153
|
|
|
@@ -125,14 +156,14 @@ Several Python packages wrap cmark or provide CommonMark parsing. Here's how the
|
|
|
125
156
|
| | **multimark** | **[cmarkgfm](https://github.com/theacodes/cmarkgfm)** | **[commonmark.py](https://github.com/readthedocs/commonmark.py)** |
|
|
126
157
|
|---|---|---|---|
|
|
127
158
|
| Engine | cmark-gfm (C, vendored) | cmark-gfm (C, vendored) | Pure Python |
|
|
128
|
-
| Output formats | HTML, LaTeX, man, XML, CommonMark | HTML only | HTML only |
|
|
159
|
+
| Output formats | HTML, LaTeX, man, XML, CommonMark, plaintext | HTML only | HTML only |
|
|
129
160
|
| GFM extensions | ✓ | ✓ | ✗ |
|
|
130
161
|
| Safe by default | ✓ | ✓ | ✗ |
|
|
131
162
|
| Convenience kwargs | `smart=True`, `unsafe=True`, etc. | Raw bitmask only | N/A |
|
|
132
163
|
| Performance | **Fastest** (14% faster than cmarkgfm) | Fast | ~31× slower |
|
|
133
164
|
| Maintained | Active (2026) | Active (2025) | Unmaintained (2019) |
|
|
134
165
|
|
|
135
|
-
multimark uses the same battle-tested C library as `cmarkgfm` but exposes all
|
|
166
|
+
multimark uses the same battle-tested C library as `cmarkgfm` but exposes all six of cmark's output formats (not just HTML). The API is designed around keyword arguments rather than opaque bitmasks, and unsafe content is blocked by default so the safe choice requires no extra configuration.
|
|
136
167
|
|
|
137
168
|
Thanks to extension pointer caching and reduced Python-side overhead, multimark is the **fastest Python Markdown-to-HTML library**. Take a look at the [benchmarks](https://posit-dev.github.io/multimark/user-guide/performance.html) for more detail on this.
|
|
138
169
|
|
|
@@ -12,21 +12,27 @@ Built with cibuildwheel using the `cp39-abi3` tag.
|
|
|
12
12
|
|
|
13
13
|
| Platform | Architectures | Wheel tag |
|
|
14
14
|
|----------|--------------|-----------|
|
|
15
|
-
| Linux (manylinux) | x86_64 | `cp39-abi3-manylinux_*
|
|
15
|
+
| Linux (manylinux/musllinux) | x86_64, aarch64 | `cp39-abi3-manylinux_*_{x86_64,aarch64}`, `cp39-abi3-musllinux_*_{x86_64,aarch64}` |
|
|
16
16
|
| macOS | x86_64, arm64 | `cp39-abi3-macosx_*_x86_64`, `cp39-abi3-macosx_*_arm64` |
|
|
17
17
|
| Windows | x86_64 | `cp39-abi3-win_amd64` |
|
|
18
18
|
|
|
19
|
+
Linux aarch64 wheels are built and tested under QEMU on the x86_64 GitHub Actions runner.
|
|
20
|
+
|
|
19
21
|
Skipped: 32-bit Windows (`win32`), 32-bit Linux (`manylinux_i686`), musl 32-bit (`musllinux_i686`).
|
|
20
22
|
|
|
21
23
|
## Pyodide / WebAssembly Wheels
|
|
22
24
|
|
|
23
|
-
Built with cibuildwheel using `CIBW_PLATFORM=pyodide
|
|
25
|
+
Built with cibuildwheel 4.x using `CIBW_PLATFORM=pyodide`, and published to PyPI with the native wheels. They use the PEP 783 `pyemscripten` platform tag, so `micropip.install("multimark")` finds them. These allow multimark to run in browser-based Python environments (Pyodide, JupyterLite, Shinylive).
|
|
24
26
|
|
|
25
27
|
| Pyodide Version | Python | Emscripten | Wheel tag |
|
|
26
28
|
|----------------|--------|------------|-----------|
|
|
27
|
-
|
|
|
29
|
+
| 314.x | 3.14 | 5.0.3 | `cp39-abi3-pyemscripten_2026_0_wasm32` |
|
|
30
|
+
|
|
31
|
+
Pyodide 0.28/0.29 (Python 3.13) is a different ABI and is not built. Its `pyemscripten_2025_0` wheel would only install on Pyodide 0.29.4 and later, because earlier versions bundle a micropip older than 0.11.1, which does not recognise the `pyemscripten` tag.
|
|
32
|
+
|
|
33
|
+
Threading and CLI tests are skipped under Pyodide (emscripten does not support pthreads or subprocesses). For the same reason, `markdown_to_html_batch(..., workers=N)` with `N > 1` raises `RuntimeError` under Pyodide. Leave `workers` unset there.
|
|
28
34
|
|
|
29
|
-
|
|
35
|
+
The Pyodide wheel is uploaded to PyPI in its own job, after the native wheels and sdist. If the Pyodide build, its tests, or its upload fail, the native release is still published.
|
|
30
36
|
|
|
31
37
|
## Source Distribution
|
|
32
38
|
|
|
@@ -57,4 +63,4 @@ gh workflow run test-sdist.yml
|
|
|
57
63
|
|
|
58
64
|
## Configuration
|
|
59
65
|
|
|
60
|
-
All cibuildwheel settings live in `pyproject.toml` under `[tool.cibuildwheel]`. The release CI workflow (`ci.yml`) and local Makefile targets read from the same configuration.
|
|
66
|
+
All cibuildwheel settings live in `pyproject.toml` under `[tool.cibuildwheel]`. The release CI workflow (`ci.yml`) and local Makefile targets read from the same configuration. Native wheels are built with cibuildwheel 2.23.4 and Pyodide wheels with 4.2.1.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "cf1c5698b2087f39f255be422442d6c5",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: \"[Options]{.doc-object-name .doc-class .doc-label .doc-label-enum}\"\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nCommonMark/GFM parsing and rendering options.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/__init__.py#L25-L82){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.CLASS}\n```python\nOptions\n```\n:::\n\n::: {.doc-text}\n\nAn `IntFlag` enumeration of all option flags supported by the cmark-gfm library.\nOptions can be combined using the bitwise OR operator (`|`) and passed to any\nrenderer's `options=` parameter. This provides a composable, lower-level alternative\nto the named boolean keyword arguments available on each renderer function.\n\nMost users will prefer the named keyword arguments (e.g., `smart=True`) for common\noptions. The `Options` bitmask is useful when you need to combine multiple flags\ninto a single reusable value, or when working with GFM-specific flags that do not\nhave dedicated keyword arguments.\n:::\n\n## Examples {.doc-examples}\n\nCombine multiple flags with the `|` operator:\n\n::: {#50c5d8bd .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_html, Options\n\nopts = Options.SMART | Options.UNSAFE\nmarkdown_to_html('\"Hello\" -- world', options=opts)\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'<p>“Hello” – world</p>\\n'\n```\n:::\n:::\n\n\nMix a bitmask with named keyword arguments (they are OR'd together):\n\n::: {#fb398a5a .cell execution_count=2}\n``` {.python .cell-code}\ntext = \"Here's some *text* to convert\"\nmarkdown_to_html(text, options=Options.SMART, footnotes=True)\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'<p>Here’s some <em>text</em> to convert</p>\\n'\n```\n:::\n:::\n\n\nUse GFM-specific flags that have no keyword shortcut:\n\n::: {#8aab1470 .cell execution_count=3}\n``` {.python .cell-code}\nmarkdown_to_html(\n \"~~deleted~~\",\n options=Options.STRIKETHROUGH_DOUBLE_TILDE,\n extensions=[\"strikethrough\"],\n)\n```\n\n::: {.cell-output .cell-output-display execution_count=3}\n```\n'<p><del>deleted</del></p>\\n'\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"Options_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "f88559de60babb56307135b4434b4e13",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [cmark_version()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nReturn the version string of the vendored cmark-gfm library.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L849-L869){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\ncmark_version()\n```\n:::\n\n::: {.doc-text}\n\nReports the version of the bundled cmark-gfm C library that multimark was compiled\nagainst. This is useful for debugging or confirming which release of the underlying\nparser is in use.\n:::\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: A version string in the format `\"X.Y.Z.gfm.N\"` (e.g., `\"0.29.0.gfm.13\"`).\n:::\n\n## Examples {.doc-examples}\n\n::: {#3f3b1eed .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import cmark_version\n\ncmark_version()\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'0.29.0.gfm.13'\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"cmark_version_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "56e022dfeb99ac944c94bf1c3652b0c9",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_commonmark()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render back as normalized CommonMark.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L598-L723){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_commonmark(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n width=0,\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nParses the input Markdown into an AST and re-renders it as CommonMark. This\neffectively normalizes the formatting: different but semantically equivalent\nMarkdown inputs (e.g., `*italic*` vs `_italic_`, varying list indentation) will\nproduce a canonical output form.\n\nThis is useful for round-trip testing, canonical formatting, or cleaning up\ninconsistently formatted documents. The output of this function, when parsed again,\nproduces the same AST as the original input.\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and normalize. Must be a Python `str`.\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks as hard breaks (backslash-newline). By default, this is\n `False`.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Allow raw HTML to pass through. By default, this is `False`, which replaces raw\n HTML with a comment placeholder.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable. Valid names are `\"table\"`,\n `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n\n<code>[width]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: The column at which to wrap output lines. Set to `0` (the default) to disable\n line wrapping entirely. This is useful for producing line-wrapped output for\n version-control-friendly diffs.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags (e.g., `Options.SMART | Options.UNSAFE`).\n Merged via OR with any boolean keyword arguments set to `True`.\n Defaults to `0`.\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. When both styles are provided, they\nare merged via OR. See `markdown_to_html()` for a detailed explanation.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The normalized CommonMark string.\n:::\n\n## Examples {.doc-examples}\n\nNormalize inconsistent formatting:\n\n::: {#60593a47 .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_commonmark\n\nmarkdown_to_commonmark(\"_hello_ **world**\")\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'*hello* **world**\\n'\n```\n:::\n:::\n\n\nVerify round-trip stability (parse, render, re-parse produces the same HTML):\n\n::: {#1f868b98 .cell execution_count=2}\n``` {.python .cell-code}\nfrom multimark import markdown_to_commonmark, markdown_to_html\n\noriginal = \"**bold** and *italic*\"\nnormalized = markdown_to_commonmark(original)\nassert markdown_to_html(original) == markdown_to_html(normalized)\n```\n:::\n\n\nWrap at 80 columns for version-control-friendly output:\n\n::: {#409cc51d .cell execution_count=3}\n``` {.python .cell-code}\nlong_document = \"This is a long sentence for demonstration. \" * 10\nprint(markdown_to_commonmark(long_document, width=80))\n```\n\n::: {.cell-output .cell-output-stdout}\n```\nThis is a long sentence for demonstration. This is a long sentence for\ndemonstration. This is a long sentence for demonstration. This is a long\nsentence for demonstration. This is a long sentence for demonstration. This is a\nlong sentence for demonstration. This is a long sentence for demonstration. This\nis a long sentence for demonstration. This is a long sentence for demonstration.\nThis is a long sentence for demonstration.\n\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_commonmark_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "007dc2a6be03f4138e3c3c1ba02a5ce8",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_html()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render as HTML.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L78-L232){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_html(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n sourcepos=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nTakes a Markdown string and returns the corresponding HTML output. By default,\nraw HTML embedded in the Markdown is stripped for security (replaced with an HTML\ncomment). Set `unsafe=True` to allow raw HTML passthrough.\n\nThe parser is fully [CommonMark spec](https://spec.commonmark.org/) compliant. When\nGFM extensions are enabled via `extensions=`, additional syntax is recognized\n(tables, strikethrough, autolinks, tag filtering, and task lists).\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and render. Can be any length, from a single\n inline fragment to a full document. Must be a Python `str` (not bytes).\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks (single newlines within a paragraph) as `<br />` tags.\n By default, this is `False` and soft breaks are rendered as spaces, matching the\n CommonMark specification behavior.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST before rendering. This can\n produce slightly cleaner output in edge cases. By default, this is `False`.\n\n<code>[sourcepos]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Include `data-sourcepos` attributes on block-level HTML elements indicating\n their line/column positions in the original Markdown source. Useful for building\n editors or source-mapping tools. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Allow raw HTML and potentially dangerous links to pass through to the output\n without sanitization. When `False` (the default), raw HTML blocks and inline\n HTML are replaced with a comment `<!-- raw HTML omitted -->`, and dangerous\n URLs (e.g., `javascript:`) are suppressed.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. When `True`, `[^label]` markers and\n `[^label]: content` definitions are recognized and rendered as numbered\n footnotes with backlinks. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable during parsing. Valid names are\n `\"table\"`, `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n An empty sequence (the default) parses standard CommonMark only.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags. Build it by OR-ing flags together, e.g.,\n `Options.SMART | Options.UNSAFE`. This value is combined (via OR) with any named\n boolean parameters that are set to `True`, so you can mix both styles freely.\n Defaults to `0` (no additional flags beyond those set by keyword arguments).\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. Using `smart=True` is equivalent to\npassing `options=Options.SMART`. When both are provided, they are merged:\n`markdown_to_html(text, smart=True, options=Options.UNSAFE)` is the same as\n`options=Options.SMART | Options.UNSAFE`.\n\nSome flags (like `Options.GITHUB_PRE_LANG`, `Options.STRIKETHROUGH_DOUBLE_TILDE`,\nand `Options.LIBERAL_HTML_TAG`) have no keyword shortcut and can only be set via\nthe `options` parameter.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The rendered HTML string. Block-level elements end with a trailing newline.\n:::\n\n## Examples {.doc-examples}\n\nRender basic Markdown to HTML:\n\n::: {#cad80958 .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_html\n\nmarkdown_to_html(\"**bold** and *italic*\")\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'<p><strong>bold</strong> and <em>italic</em></p>\\n'\n```\n:::\n:::\n\n\nEnable smart punctuation:\n\n::: {#35dc7203 .cell execution_count=2}\n``` {.python .cell-code}\nmarkdown_to_html('\"Hello\" -- world...', smart=True)\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'<p>“Hello” – world…</p>\\n'\n```\n:::\n:::\n\n\nAllow raw HTML passthrough:\n\n::: {#f3b14ec1 .cell execution_count=3}\n``` {.python .cell-code}\nmarkdown_to_html(\"<div>custom</div>\", unsafe=True)\n```\n\n::: {.cell-output .cell-output-display execution_count=3}\n```\n'<div>custom</div>\\n'\n```\n:::\n:::\n\n\nUse GFM table extension:\n\n::: {#4c132ac6 .cell execution_count=4}\n``` {.python .cell-code}\nmarkdown_to_html(\n \"| A | B |\\n|---|---|\\n| 1 | 2 |\\n\",\n extensions=[\"table\"],\n)\n```\n\n::: {.cell-output .cell-output-display execution_count=4}\n```\n'<table>\\n<thead>\\n<tr>\\n<th>A</th>\\n<th>B</th>\\n</tr>\\n</thead>\\n<tbody>\\n<tr>\\n<td>1</td>\\n<td>2</td>\\n</tr>\\n</tbody>\\n</table>\\n'\n```\n:::\n:::\n\n\nCombine multiple features:\n\n::: {#66608d94 .cell execution_count=5}\n``` {.python .cell-code}\nmarkdown_to_html(\n \"~~old~~ -> new\\n\\nVisit https://example.com\\n\",\n extensions=[\"strikethrough\", \"autolink\"],\n smart=True,\n)\n```\n\n::: {.cell-output .cell-output-display execution_count=5}\n```\n'<p><del>old</del> -> new</p>\\n<p>Visit <a href=\"https://example.com\">https://example.com</a></p>\\n'\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_html_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "e8b344dcce2b471df37ac0e592012552",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_latex()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render as LaTeX.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L348-L474){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_latex(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n width=0,\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nConverts Markdown to LaTeX source suitable for inclusion in a `.tex` document.\nInline formatting maps to LaTeX commands (`\\textbf{}`, `\\emph{}`, `\\texttt{}`),\nheadings become sectioning commands (`\\section{}`, `\\subsection{}`, etc.), and\nlinks use `\\href{}{}`.\n\nThe output is a fragment (not a full document): it does not include\n`\\documentclass`, `\\begin{document}`, or preamble. You can concatenate it into\nyour own LaTeX document structure.\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and render. Must be a Python `str`.\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks as hard breaks (`\\\\`). By default, this is `False`.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Allow raw HTML to pass through. Since LaTeX is the target format, raw HTML is\n typically irrelevant. By default, this is `False`.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable. Valid names are `\"table\"`,\n `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n\n<code>[width]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: The column at which to wrap output lines. Set to `0` (the default) to disable\n line wrapping entirely. A value like `80` produces lines of at most 80\n characters where possible.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags (e.g., `Options.SMART | Options.UNSAFE`).\n Merged via OR with any boolean keyword arguments set to `True`.\n Defaults to `0`.\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. When both styles are provided, they\nare merged via OR. See `markdown_to_html()` for a detailed explanation.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The rendered LaTeX string.\n:::\n\n## Examples {.doc-examples}\n\nRender inline formatting:\n\n::: {#a5c3dcde .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_latex\n\nmarkdown_to_latex(\"**bold** and *italic*\")\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'\\\\textbf{bold} and \\\\emph{italic}\\n'\n```\n:::\n:::\n\n\nRender a heading:\n\n::: {#eb53efdd .cell execution_count=2}\n``` {.python .cell-code}\nmarkdown_to_latex(\"# Introduction\")\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'\\\\section{Introduction}\\n'\n```\n:::\n:::\n\n\nEnable line wrapping at 72 columns:\n\n::: {#48d87433 .cell execution_count=3}\n``` {.python .cell-code}\nlong_text = \"This is a very long paragraph. \" * 10\nprint(markdown_to_latex(long_text, width=72))\n```\n\n::: {.cell-output .cell-output-stdout}\n```\nThis is a very long paragraph. This is a very long paragraph. This is a\nvery long paragraph. This is a very long paragraph. This is a very long\nparagraph. This is a very long paragraph. This is a very long paragraph.\nThis is a very long paragraph. This is a very long paragraph. This is a\nvery long paragraph.\n\n```\n:::\n:::\n\n\nUse smart punctuation for typographic output:\n\n::: {#c7de3086 .cell execution_count=4}\n``` {.python .cell-code}\nmarkdown_to_latex('\"Hello,\" she said --- \"goodbye.\"', smart=True)\n```\n\n::: {.cell-output .cell-output-display execution_count=4}\n```\n\"``Hello,'' she said --- ``goodbye.''\\n\"\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_latex_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "0a56c36654447c031cec99a0cdf8248c",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_man()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render as a groff man page.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L477-L595){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_man(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n width=0,\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nProduces groff-format output suitable for use with the `man` command or inclusion\nin manual page source files. Inline formatting maps to font switching requests\n(`\\f[B]`, `\\f[I]`, `\\f[CR]`), paragraphs use `.PP`, and headings use `.SH` or\n`.SS` macros.\n\nThe output is a fragment and does not include a `.TH` title header. Wrap it in your\nown man page structure to produce a complete manual page.\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and render. Must be a Python `str`.\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks as hard breaks (`.br`). By default, this is `False`.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Allow raw HTML to pass through. Since groff is the target format, raw HTML is\n typically irrelevant. By default, this is `False`.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable. Valid names are `\"table\"`,\n `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n\n<code>[width]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: The column at which to wrap output lines. Set to `0` (the default) to disable\n line wrapping entirely.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags (e.g., `Options.SMART | Options.UNSAFE`).\n Merged via OR with any boolean keyword arguments set to `True`.\n Defaults to `0`.\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. When both styles are provided, they\nare merged via OR. See `markdown_to_html()` for a detailed explanation.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The rendered groff man page string.\n:::\n\n## Examples {.doc-examples}\n\nRender a paragraph with bold and italic:\n\n::: {#666d349f .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_man\n\nmarkdown_to_man(\"**bold** and *italic*\")\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'.PP\\n\\\\f[B]bold\\\\f[] and \\\\f[I]italic\\\\f[]\\n'\n```\n:::\n:::\n\n\nRender a heading:\n\n::: {#5f3639dd .cell execution_count=2}\n``` {.python .cell-code}\nmarkdown_to_man(\"## Options\")\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'.SS\\nOptions\\n'\n```\n:::\n:::\n\n\nWrap at 72 columns:\n\n::: {#4d08b991 .cell execution_count=3}\n``` {.python .cell-code}\nlong_paragraph = \"This is a long paragraph of text. \" * 10\nprint(markdown_to_man(long_paragraph, width=72))\n```\n\n::: {.cell-output .cell-output-stdout}\n```\n.PP\nThis is a long paragraph of text. This is a long paragraph of text. This\nis a long paragraph of text. This is a long paragraph of text. This is a\nlong paragraph of text. This is a long paragraph of text. This is a long\nparagraph of text. This is a long paragraph of text. This is a long\nparagraph of text. This is a long paragraph of text.\n\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_man_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "104fa981db28fe772692524fb27260fe",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_plaintext()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render as plain text.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L726-L846){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_plaintext(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n width=0,\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nRemoves heading, emphasis, link, and code delimiters while preserving their\ntext. Link destinations and image URLs are omitted; image descriptions are\nretained. Lists keep their markers and indentation, and paragraphs remain\nseparated by blank lines.\n\nGFM tables retain pipe-table syntax, task lists retain checkbox markers, and\nstrikethrough text is surrounded by single tildes. Enabled footnotes retain\nnumbered references and definitions. Raw HTML blocks, including their text,\nare omitted; inline HTML tags are omitted without removing surrounding text.\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and render. Must be a Python `str`.\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks as hard breaks (newlines). By default, this is\n `False`. When enabled, width-based wrapping is disabled.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Raw HTML is always omitted, regardless of this flag. By default, this is\n `False`.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable. Valid names are `\"table\"`,\n `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n\n<code>[width]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: The column at which to wrap output lines. Set to `0` (the default) to disable\n line wrapping entirely and preserve soft line breaks. With a positive width,\n soft line breaks become spaces before wrapping. Code blocks are not wrapped.\n Ignored when `hardbreaks=True`.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags (e.g., `Options.SMART | Options.UNSAFE`).\n Merged via OR with any boolean keyword arguments set to `True`.\n Defaults to `0`. `Options.NOBREAKS` converts soft line breaks to spaces and\n disables automatic wrapping.\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. When both styles are provided, they\nare merged via OR. See `markdown_to_html()` for a detailed explanation.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The rendered text, including a trailing newline. Empty input returns\n `\"\\n\"`. Output whitespace is not stripped.\n:::\n\n## Examples {.doc-examples}\n\nRemove inline formatting:\n\n::: {#ed635f6f .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_plaintext\n\nmarkdown_to_plaintext(\"**Hello**, *world*!\")\n```\n\n::: {.cell-output .cell-output-display execution_count=1}\n```\n'Hello, world!\\n'\n```\n:::\n:::\n\n\nWrap readable text at 72 columns:\n\n::: {#f6ab8477 .cell execution_count=2}\n``` {.python .cell-code}\nmarkdown_to_plaintext(\"A paragraph with **bold** text. \" * 5, width=72)\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'A paragraph with bold text. A paragraph with bold text. A paragraph with\\nbold text. A paragraph with bold text. A paragraph with bold text.\\n'\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_plaintext_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hash": "2bc37e402a04a5a11a20e6922f3afb5f",
|
|
3
|
+
"result": {
|
|
4
|
+
"engine": "jupyter",
|
|
5
|
+
"markdown": "---\ntitle: >-\n [markdown_to_xml()]{.doc-object-name .doc-function .doc-label\n .doc-label-function}\nbody-classes: doc-api-page doc-py-api-page\nshift-heading-level-by: 0\nbread-crumbs: false\ntoc-depth: 3\npage-navigation: false\nhtml-table-processing: none\n---\n\n::: {.doc-subject}\n\nParse CommonMark/GFM and render as XML.\n:::\n\n::: {.doc-usage-source}\nUsage\n\n[Source](https://github.com/posit-dev/multimark/blob/feat-markdown-to-plaintext/src/multimark/_cmark.py#L235-L345){target=\"_blank\" rel=\"noopener\"}\n:::\n\n::: {.doc-signature .doc-Kind.FUNCTION}\n```python\nmarkdown_to_xml(\n text,\n *,\n hardbreaks=False,\n smart=False,\n normalize=False,\n sourcepos=False,\n unsafe=False,\n footnotes=False,\n extensions=(),\n options=0,\n)\n```\n:::\n\n::: {.doc-text}\n\nProduces an XML representation of the parsed abstract syntax tree (AST). Each\nMarkdown construct is represented as a named element (e.g., `<paragraph>`,\n`<strong>`, `<code_block>`), with text content preserved in `<text>` elements.\n\nThe XML output conforms to the CommonMark DTD and includes an XML declaration and\nDOCTYPE. This format is useful for debugging, AST inspection, or piping into\nXML-based toolchains.\n:::\n\n## Parameters {.doc-parameters}\n\n::: {.doc-definition-items}\n<code>[text]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [str]{.doc-parameter-annotation}</code>\n\n: The Markdown string to parse and render. Must be a Python `str`.\n\n<code>[hardbreaks]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Render soft line breaks as hard breaks in the AST. By default, this is `False`.\n\n<code>[smart]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Convert straight quotes to curly quotes, `--` to en-dashes, `---` to em-dashes,\n and `...` to ellipses. By default, this is `False`.\n\n<code>[normalize]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Consolidate adjacent text nodes in the parsed AST. By default, this is `False`.\n\n<code>[sourcepos]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Include `sourcepos` attributes on elements indicating their line/column\n positions in the original Markdown source. By default, this is `False`.\n\n<code>[unsafe]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Allow raw HTML to pass through. By default, this is `False`.\n\n<code>[footnotes]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [bool]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[False]{.va}]{.doc-parameter-default}</code>\n\n: Enable footnote syntax parsing. By default, this is `False`.\n\n<code>[extensions]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [Sequence[str]]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [()]{.doc-parameter-default}</code>\n\n: A sequence of GFM extension names to enable. Valid names are `\"table\"`,\n `\"strikethrough\"`, `\"autolink\"`, `\"tagfilter\"`, and `\"tasklist\"`.\n\n<code>[options]{.doc-parameter-name}[:]{.doc-parameter-annotation-sep} [int]{.doc-parameter-annotation} [=]{.doc-parameter-default-sep .op} [[0]{.dv}]{.doc-parameter-default}</code>\n\n: An integer bitmask of `Options` flags (e.g., `Options.SMART | Options.UNSAFE`).\n Merged via OR with any boolean keyword arguments set to `True`.\n Defaults to `0`.\n:::\n\n## Keyword Arguments Vs. Options Flags {.doc-keyword-arguments-vs-options-flags}\n\nThe boolean keyword arguments (`smart`, `unsafe`, `hardbreaks`, etc.) are convenience\nshortcuts for the most common `Options` flags. When both styles are provided, they\nare merged via OR. See `markdown_to_html()` for a detailed explanation.\n\n## Returns {.doc-returns}\n\n::: {.doc-definition-items}\n<code> [str]{.doc-parameter-annotation}</code>\n\n: The rendered XML string, including the XML declaration and DOCTYPE.\n:::\n\n## Examples {.doc-examples}\n\nInspect the AST structure of a simple document:\n\n::: {#1d3eed25 .cell execution_count=1}\n``` {.python .cell-code}\nfrom multimark import markdown_to_xml\n\nprint(markdown_to_xml(\"**hello**\"))\n```\n\n::: {.cell-output .cell-output-stdout}\n```\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n<document xmlns=\"http://commonmark.org/xml/1.0\">\n <paragraph>\n <strong>\n <text xml:space=\"preserve\">hello</text>\n </strong>\n </paragraph>\n</document>\n\n```\n:::\n:::\n\n\nAdd source position information:\n\n::: {#099b1854 .cell execution_count=2}\n``` {.python .cell-code}\nmarkdown_to_xml(\"# Title\\n\\nBody text\\n\", sourcepos=True)\n```\n\n::: {.cell-output .cell-output-display execution_count=2}\n```\n'<?xml version=\"1.0\" encoding=\"UTF-8\"?>\\n<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\\n<document sourcepos=\"1:1-3:9\" xmlns=\"http://commonmark.org/xml/1.0\">\\n <heading sourcepos=\"1:1-1:7\" level=\"1\">\\n <text sourcepos=\"1:3-1:7\" xml:space=\"preserve\">Title</text>\\n </heading>\\n <paragraph sourcepos=\"3:1-3:9\">\\n <text sourcepos=\"3:1-3:9\" xml:space=\"preserve\">Body text</text>\\n </paragraph>\\n</document>\\n'\n```\n:::\n:::\n\n\n",
|
|
6
|
+
"supporting": [
|
|
7
|
+
"markdown_to_xml_files/figure-html"
|
|
8
|
+
],
|
|
9
|
+
"filters": [],
|
|
10
|
+
"includes": {}
|
|
11
|
+
}
|
|
12
|
+
}
|