bucket_B1/python-markdown-it-py

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-markdown-it-py
   4 VERSION=                3.0.0
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Port of Markdown-it, markdown done right (3.11)
   8 SDESC[v12]=             Port of Markdown-it, markdown done right (3.12)
   9 HOMEPAGE=               https://github.com/executablebooks/markdown-it-py
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f
  14 DISTFILE[1]=            markdown_it_py-3.0.0-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 USES=                   cpe
  25
  26 DISTNAME=               markdown_it_py-3.0.0.dist-info
  27
  28 CPE_PRODUCT=            markdown-it-py
  29 CPE_VENDOR=             executablebooks
  30 GENERATED=              yes
  31
  32 [PY311].RUN_DEPENDS_ON=                 python-mdurl:single:v11
  33 [PY311].USES_ON=                        python:v11,wheel
  34
  35 [PY312].RUN_DEPENDS_ON=                 python-mdurl:single:v12
  36 [PY312].USES_ON=                        python:v12,wheel
  37
  38 [FILE:2265:descriptions/desc.single]
  39 # markdown-it-py
  40
  41 [![Github-CI][github-ci]][github-link]
  42 [![Coverage Status][codecov-badge]][codecov-link]
  43 [![PyPI][pypi-badge]][pypi-link]
  44 [![Conda][conda-badge]][conda-link]
  45 [![Code style: black][black-badge]][black-link]
  46 [![PyPI - Downloads][install-badge]][install-link]
  47
  48 > Markdown parser done right.
  49
  50 - Follows the __[CommonMark spec]__ for baseline parsing
  51 - Configurable syntax: you can add new rules and even replace existing
  52 ones.
  53 - Pluggable: Adds syntax extensions to extend the parser (see the [plugin
  54 list][md-plugins]).
  55 - High speed (see our [benchmarking tests][md-performance])
  56 - [Safe by default][md-security]
  57 - Member of [Google's Assured Open Source Software]
  58
  59 This is a Python port of [markdown-it], and some of its associated plugins.
  60 For more details see: <https://markdown-it-py.readthedocs.io>.
  61
  62 For details on [markdown-it] itself, see:
  63
  64 - The __[Live demo]__
  65 - [The markdown-it README][markdown-it-readme]
  66
  67 ## Installation
  68
  69 ```bash
  70 conda install -c conda-forge markdown-it-py
  71 `
  72
  73 or
  74
  75 `bash
  76 pip install markdown-it-py[plugins]
  77 `
  78
  79 or with extras
  80
  81 `bash
  82 conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins
  83 pip install markdown-it-py[linkify,plugins]
  84 ```
  85
  86 ## Usage
  87
  88 ### Python API Usage
  89
  90 Render markdown to HTML with markdown-it-py and a custom configuration
  91 with and without plugins and features:
  92
  93 ```python
  94 from markdown_it import MarkdownIt
  95 from mdit_py_plugins.front_matter import front_matter_plugin
  96 from mdit_py_plugins.footnote import footnote_plugin
  97
  98 md = (
  99     MarkdownIt('commonmark' ,{'breaks':True,'html':True})
 100     .use(front_matter_plugin)
 101     .use(footnote_plugin)
 102     .enable('table')
 103 )
 104 text = ("""
 105 ---
 106 a: 1
 107 ---
 108
 109 a | b
 110 - | -
 111 1 | 2
 112
 113 A footnote [^1]
 114
 115 [^1]: some details
 116 """)
 117 tokens = md.parse(text)
 118 html_text = md.render(text)
 119
 120 ## To export the html to a file, uncomment the lines below:
 121 # from pathlib import Path
 122 # Path("output.html").write_text(html_text)
 123 ```
 124
 125 ### Command-line Usage
 126
 127 Render markdown to HTML with markdown-it-py from the
 128 command-line:
 129
 130 ```console
 131 usage: markdown-it [-h] [-v] [filenames [filenames ...]]
 132
 133 Parse one or more markdown files, convert each to HTML, and print to stdout
 134
 135 positional arguments:
 136   filenames      specify an optional list of files to convert
 137
 138 optional arguments:
 139
 140
 141 [FILE:116:distinfo]
 142 355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1        87528 markdown_it_py-3.0.0-py3-none-any.whl
 143