mkconvert 0.11.5__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.
- mkconvert-0.11.5/.copier-answers.yml +21 -0
- mkconvert-0.11.5/.github/FUNDING.yml +3 -0
- mkconvert-0.11.5/.github/copilot-instructions.md +19 -0
- mkconvert-0.11.5/.github/dependabot.yml +9 -0
- mkconvert-0.11.5/.github/workflows/build.yml +88 -0
- mkconvert-0.11.5/.github/workflows/documentation.yml +57 -0
- mkconvert-0.11.5/.gitignore +32 -0
- mkconvert-0.11.5/.pre-commit-config.yaml +48 -0
- mkconvert-0.11.5/LICENSE +22 -0
- mkconvert-0.11.5/PKG-INFO +131 -0
- mkconvert-0.11.5/README.md +57 -0
- mkconvert-0.11.5/benchmark/__init__.py +0 -0
- mkconvert-0.11.5/benchmark/bench.py +181 -0
- mkconvert-0.11.5/benchmark/cases/atx.txt +17 -0
- mkconvert-0.11.5/benchmark/cases/auto_links.txt +1 -0
- mkconvert-0.11.5/benchmark/cases/blockcode.txt +0 -0
- mkconvert-0.11.5/benchmark/cases/blockhtml.txt +41 -0
- mkconvert-0.11.5/benchmark/cases/blockquote.txt +7 -0
- mkconvert-0.11.5/benchmark/cases/emphasis.txt +1 -0
- mkconvert-0.11.5/benchmark/cases/fenced.txt +30 -0
- mkconvert-0.11.5/benchmark/cases/insane_ol.txt +31 -0
- mkconvert-0.11.5/benchmark/cases/insane_ul.txt +41 -0
- mkconvert-0.11.5/benchmark/cases/normal_ol.txt +16 -0
- mkconvert-0.11.5/benchmark/cases/normal_ul.txt +37 -0
- mkconvert-0.11.5/benchmark/cases/paragraph.txt +264 -0
- mkconvert-0.11.5/benchmark/cases/pymdownx_admonitions.txt +2 -0
- mkconvert-0.11.5/benchmark/cases/ref_links.txt +19 -0
- mkconvert-0.11.5/benchmark/cases/setext.txt +24 -0
- mkconvert-0.11.5/benchmark/cases/std_links.txt +2 -0
- mkconvert-0.11.5/docs/.empty +0 -0
- mkconvert-0.11.5/duties.py +60 -0
- mkconvert-0.11.5/mkdocs.yml +92 -0
- mkconvert-0.11.5/overrides/_dummy.txt +1 -0
- mkconvert-0.11.5/pyproject.toml +259 -0
- mkconvert-0.11.5/src/mkconvert/__init__.py +50 -0
- mkconvert-0.11.5/src/mkconvert/extensions.py +126 -0
- mkconvert-0.11.5/src/mkconvert/html_to_md/__init__.py +0 -0
- mkconvert-0.11.5/src/mkconvert/html_to_md/base.py +96 -0
- mkconvert-0.11.5/src/mkconvert/html_to_md/factory.py +317 -0
- mkconvert-0.11.5/src/mkconvert/html_to_md/htmd_converter.py +193 -0
- mkconvert-0.11.5/src/mkconvert/html_to_md/markdownify_converter.py +258 -0
- mkconvert-0.11.5/src/mkconvert/parsers/__init__.py +0 -0
- mkconvert-0.11.5/src/mkconvert/parsers/base_parser.py +31 -0
- mkconvert-0.11.5/src/mkconvert/parsers/comrak_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/comrak_parser/parser.py +176 -0
- mkconvert-0.11.5/src/mkconvert/parsers/github_api_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/github_api_parser/parser.py +62 -0
- mkconvert-0.11.5/src/mkconvert/parsers/markdown2_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/markdown2_parser/parser.py +116 -0
- mkconvert-0.11.5/src/mkconvert/parsers/markdown_it_pyrs_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/markdown_it_pyrs_parser/parser.py +194 -0
- mkconvert-0.11.5/src/mkconvert/parsers/marko_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/marko_parser/parser.py +134 -0
- mkconvert-0.11.5/src/mkconvert/parsers/mistletoe_parser/__init__.py +1 -0
- mkconvert-0.11.5/src/mkconvert/parsers/mistune_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/mistune_parser/parser.py +120 -0
- mkconvert-0.11.5/src/mkconvert/parsers/parser.py +150 -0
- mkconvert-0.11.5/src/mkconvert/parsers/pyromark_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/pyromark_parser/parser.py +181 -0
- mkconvert-0.11.5/src/mkconvert/parsers/python_markdown_parser/__init__.py +5 -0
- mkconvert-0.11.5/src/mkconvert/parsers/python_markdown_parser/parser.py +92 -0
- mkconvert-0.11.5/src/mkconvert/post_processors/__init__.py +9 -0
- mkconvert-0.11.5/src/mkconvert/post_processors/base.py +39 -0
- mkconvert-0.11.5/src/mkconvert/post_processors/prettify.py +67 -0
- mkconvert-0.11.5/src/mkconvert/post_processors/registry.py +44 -0
- mkconvert-0.11.5/src/mkconvert/post_processors/sanitizer.py +65 -0
- mkconvert-0.11.5/src/mkconvert/pre_processors/__init__.py +7 -0
- mkconvert-0.11.5/src/mkconvert/pre_processors/admonition_converter.py +104 -0
- mkconvert-0.11.5/src/mkconvert/pre_processors/base.py +39 -0
- mkconvert-0.11.5/src/mkconvert/pre_processors/registry.py +44 -0
- mkconvert-0.11.5/src/mkconvert/py.typed +0 -0
- mkconvert-0.11.5/src/mkconvert/sanitizers/__init__.py +6 -0
- mkconvert-0.11.5/src/mkconvert/sanitizers/base.py +41 -0
- mkconvert-0.11.5/src/mkconvert/sanitizers/bleach_sanitizer.py +64 -0
- mkconvert-0.11.5/src/mkconvert/sanitizers/factory.py +96 -0
- mkconvert-0.11.5/src/mkconvert/sanitizers/nh3_sanitizer.py +63 -0
- mkconvert-0.11.5/src/mkconvert/tree_processors/__init__.py +28 -0
- mkconvert-0.11.5/src/mkconvert/tree_processors/base.py +216 -0
- mkconvert-0.11.5/src/mkconvert/tree_processors/extract_title.py +59 -0
- mkconvert-0.11.5/src/mkconvert/tree_processors/extract_title_lxml.py +64 -0
- mkconvert-0.11.5/src/mkconvert/tree_processors/registry.py +66 -0
- mkconvert-0.11.5/tests/__init__.py +3 -0
- mkconvert-0.11.5/tests/conftest.py +1 -0
- mkconvert-0.11.5/tests/test_extacttitlepreprocessor.py +112 -0
- mkconvert-0.11.5/tests/test_html_to_md.py +65 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Changes here will be overwritten by Copier
|
|
2
|
+
_commit: v1.8.4
|
|
3
|
+
_src_path: https://github.com/phil65/copier-phil65
|
|
4
|
+
author_email: philipptemminghoff@googlemail.com
|
|
5
|
+
author_fullname: Philipp Temminghoff
|
|
6
|
+
author_username: phil65
|
|
7
|
+
copyright_date: '2024'
|
|
8
|
+
copyright_holder: Philipp Temminghoff
|
|
9
|
+
copyright_holder_email: philipptemminghoff@googlemail.com
|
|
10
|
+
libraries_use_pydantic: true
|
|
11
|
+
libraries_use_qt: false
|
|
12
|
+
project_description: Markdown-HTML converters
|
|
13
|
+
project_name: mkconvert
|
|
14
|
+
python_minimum_version: '3.12'
|
|
15
|
+
python_package_command_line_name: mkconvert
|
|
16
|
+
python_package_distribution_name: mkconvert
|
|
17
|
+
python_package_import_name: mkconvert
|
|
18
|
+
repository_name: mkconvert
|
|
19
|
+
repository_namespace: phil65
|
|
20
|
+
repository_provider: github.com
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Code style
|
|
2
|
+
|
|
3
|
+
You can assume Python 3.12.
|
|
4
|
+
Use newest language features if possible
|
|
5
|
+
Consider using pattern matching, walrus operators and other new syntax features.
|
|
6
|
+
Adhere to pep8.
|
|
7
|
+
|
|
8
|
+
## Tests
|
|
9
|
+
|
|
10
|
+
Tests are written using PyTest. Dont put tests into a class.
|
|
11
|
+
|
|
12
|
+
## DocStrings
|
|
13
|
+
|
|
14
|
+
DocStrings are written in google-style.
|
|
15
|
+
Dont add the types to the "Args" section.
|
|
16
|
+
Only add a Return section if a value is returned and the meaning of the returned value
|
|
17
|
+
is not obvious.
|
|
18
|
+
You can use markdown admonitions with python-markdown syntax if neccessary (!!! info, !!! note, !!! warning).
|
|
19
|
+
You can use markdown tables and markdown lists if neccessary.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
name: Build
|
|
2
|
+
|
|
3
|
+
on: [push, pull_request]
|
|
4
|
+
|
|
5
|
+
jobs:
|
|
6
|
+
test:
|
|
7
|
+
runs-on: ${{ matrix.os }}
|
|
8
|
+
continue-on-error: ${{ matrix.python_version == '3.14' }}
|
|
9
|
+
strategy:
|
|
10
|
+
matrix:
|
|
11
|
+
python_version: ["3.12", "3.13", "3.14"]
|
|
12
|
+
os: ["ubuntu-latest", "macos-latest", "windows-latest"]
|
|
13
|
+
steps:
|
|
14
|
+
- name: Check out repository
|
|
15
|
+
uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Set up Python ${{ matrix.python_version }}
|
|
18
|
+
uses: actions/setup-python@v5
|
|
19
|
+
with:
|
|
20
|
+
python-version: ${{ matrix.python_version }}
|
|
21
|
+
allow-prereleases: true
|
|
22
|
+
|
|
23
|
+
- name: Install uv
|
|
24
|
+
uses: astral-sh/setup-uv@v5
|
|
25
|
+
with:
|
|
26
|
+
enable-cache: true
|
|
27
|
+
cache-dependency-glob: pyproject.toml
|
|
28
|
+
cache-suffix: py${{ matrix.python_version }}
|
|
29
|
+
|
|
30
|
+
- name: Install dependencies (uv sync)
|
|
31
|
+
run: uv sync --all-extras --no-group docs
|
|
32
|
+
|
|
33
|
+
- name: Check for code issues (ruff check)
|
|
34
|
+
uses: astral-sh/ruff-action@v3
|
|
35
|
+
|
|
36
|
+
- name: Check code format (ruff format)
|
|
37
|
+
uses: astral-sh/ruff-action@v3
|
|
38
|
+
with:
|
|
39
|
+
args: "format --check"
|
|
40
|
+
|
|
41
|
+
- name: Static type checking (MyPy)
|
|
42
|
+
run: uv run --no-group docs mypy src/mkconvert/
|
|
43
|
+
|
|
44
|
+
- name: Run tests
|
|
45
|
+
run: uv run --no-group docs pytest --cov-report=xml --cov=src/mkconvert/ --cov-report=term-missing
|
|
46
|
+
|
|
47
|
+
- name: Upload test results to Codecov
|
|
48
|
+
uses: codecov/codecov-action@v5
|
|
49
|
+
with:
|
|
50
|
+
fail_ci_if_error: false
|
|
51
|
+
verbose: true
|
|
52
|
+
|
|
53
|
+
release:
|
|
54
|
+
runs-on: ubuntu-latest
|
|
55
|
+
needs: test
|
|
56
|
+
if: startsWith(github.ref, 'refs/tags/')
|
|
57
|
+
permissions:
|
|
58
|
+
# this permission is mandatory for trusted publishing
|
|
59
|
+
id-token: write
|
|
60
|
+
contents: write
|
|
61
|
+
steps:
|
|
62
|
+
- name: Check out repository
|
|
63
|
+
uses: actions/checkout@v4
|
|
64
|
+
|
|
65
|
+
- name: Set up Python
|
|
66
|
+
uses: actions/setup-python@v5
|
|
67
|
+
with:
|
|
68
|
+
python-version: "3.12"
|
|
69
|
+
|
|
70
|
+
- name: Install uv
|
|
71
|
+
uses: astral-sh/setup-uv@v5
|
|
72
|
+
with:
|
|
73
|
+
enable-cache: true
|
|
74
|
+
cache-dependency-glob: pyproject.toml
|
|
75
|
+
cache-suffix: py${{ matrix.python_version }}
|
|
76
|
+
|
|
77
|
+
- name: Build package
|
|
78
|
+
run: uv build
|
|
79
|
+
|
|
80
|
+
- name: Publish package distributions to PyPI
|
|
81
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
82
|
+
|
|
83
|
+
- name: Release package on GitHub
|
|
84
|
+
uses: ncipollo/release-action@v1
|
|
85
|
+
with:
|
|
86
|
+
body: ${{ github.event.head_commit.message }}
|
|
87
|
+
artifacts: dist/*.whl,dist/*.tar.gz
|
|
88
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
name: Build documentation
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
9
|
+
permissions:
|
|
10
|
+
contents: read
|
|
11
|
+
pages: write
|
|
12
|
+
id-token: write
|
|
13
|
+
|
|
14
|
+
# Allow one concurrent deployment
|
|
15
|
+
concurrency:
|
|
16
|
+
group: "pages"
|
|
17
|
+
cancel-in-progress: true
|
|
18
|
+
|
|
19
|
+
# Default to bash
|
|
20
|
+
defaults:
|
|
21
|
+
run:
|
|
22
|
+
shell: bash
|
|
23
|
+
|
|
24
|
+
jobs:
|
|
25
|
+
build:
|
|
26
|
+
runs-on: ubuntu-latest
|
|
27
|
+
|
|
28
|
+
steps:
|
|
29
|
+
- uses: actions/checkout@v4
|
|
30
|
+
with:
|
|
31
|
+
fetch-depth: 0
|
|
32
|
+
- name: Set up Python
|
|
33
|
+
uses: actions/setup-python@v5
|
|
34
|
+
with:
|
|
35
|
+
python-version: "3.12"
|
|
36
|
+
- name: Install uv
|
|
37
|
+
uses: astral-sh/setup-uv@v5
|
|
38
|
+
- name: Install dependencies
|
|
39
|
+
run: |
|
|
40
|
+
uv sync --all-extras
|
|
41
|
+
- name: Build
|
|
42
|
+
run: uv run mknodes build
|
|
43
|
+
- name: Upload artifact
|
|
44
|
+
uses: actions/upload-pages-artifact@v3
|
|
45
|
+
with:
|
|
46
|
+
path: ./site
|
|
47
|
+
|
|
48
|
+
deploy:
|
|
49
|
+
environment:
|
|
50
|
+
name: github-pages
|
|
51
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
52
|
+
runs-on: ubuntu-latest
|
|
53
|
+
needs: build
|
|
54
|
+
steps:
|
|
55
|
+
- name: Deploy to GitHub Pages
|
|
56
|
+
id: deployment
|
|
57
|
+
uses: actions/deploy-pages@v4
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
# Distribution / packaging
|
|
5
|
+
*.sublime-workspace
|
|
6
|
+
# Unit test / coverage reports
|
|
7
|
+
.coverage
|
|
8
|
+
coverage.xml
|
|
9
|
+
.cache
|
|
10
|
+
.hatch
|
|
11
|
+
.pytest_cache/
|
|
12
|
+
junit.xml
|
|
13
|
+
# Jupyter Notebook
|
|
14
|
+
.ipynb_checkpoints
|
|
15
|
+
# pyenv
|
|
16
|
+
.python-version
|
|
17
|
+
# dotenv
|
|
18
|
+
.env
|
|
19
|
+
# virtualenv
|
|
20
|
+
.venv
|
|
21
|
+
# mkdocs documentation
|
|
22
|
+
/site
|
|
23
|
+
# mypy
|
|
24
|
+
.mypy_cache/
|
|
25
|
+
# .vscode
|
|
26
|
+
.vscode/
|
|
27
|
+
# OS files
|
|
28
|
+
.DS_Store
|
|
29
|
+
# uv
|
|
30
|
+
uv.lock
|
|
31
|
+
# DiskCache cache file
|
|
32
|
+
./model_cache
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
default_language_version:
|
|
2
|
+
python: python3.12
|
|
3
|
+
default_stages: [pre-commit]
|
|
4
|
+
repos:
|
|
5
|
+
- repo: local
|
|
6
|
+
hooks:
|
|
7
|
+
- id: pytest-check
|
|
8
|
+
name: pytest-check
|
|
9
|
+
entry: uv run pytest
|
|
10
|
+
language: system
|
|
11
|
+
# stages: [push]
|
|
12
|
+
types: [python]
|
|
13
|
+
pass_filenames: false
|
|
14
|
+
always_run: true
|
|
15
|
+
|
|
16
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
17
|
+
# https://pre-commit.com/hooks.html
|
|
18
|
+
rev: v5.0.0
|
|
19
|
+
hooks:
|
|
20
|
+
- id: check-added-large-files
|
|
21
|
+
- id: check-case-conflict
|
|
22
|
+
- id: check-merge-conflict
|
|
23
|
+
- id: check-toml
|
|
24
|
+
- id: check-json
|
|
25
|
+
- id: check-xml
|
|
26
|
+
- id: check-yaml
|
|
27
|
+
args: [--allow-multiple-documents, --unsafe]
|
|
28
|
+
- id: debug-statements
|
|
29
|
+
- id: detect-private-key
|
|
30
|
+
|
|
31
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
32
|
+
rev: v1.15.0
|
|
33
|
+
hooks:
|
|
34
|
+
- id: mypy
|
|
35
|
+
additional_dependencies: [orjson, pydantic]
|
|
36
|
+
|
|
37
|
+
- repo: https://github.com/charliermarsh/ruff-pre-commit
|
|
38
|
+
rev: v0.11.3
|
|
39
|
+
hooks:
|
|
40
|
+
- id: ruff
|
|
41
|
+
- id: ruff-format
|
|
42
|
+
|
|
43
|
+
- repo: https://github.com/commitizen-tools/commitizen
|
|
44
|
+
rev: v4.4.1
|
|
45
|
+
hooks:
|
|
46
|
+
- id: commitizen
|
|
47
|
+
stages: [commit-msg]
|
|
48
|
+
additional_dependencies: [typing-extensions]
|
mkconvert-0.11.5/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024, Philipp Temminghoff
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mkconvert
|
|
3
|
+
Version: 0.11.5
|
|
4
|
+
Summary: Markdown-HTML converters
|
|
5
|
+
Project-URL: Documentation, https://phil65.github.io/mkconvert/
|
|
6
|
+
Project-URL: Source, https://github.com/phil65/mkconvert
|
|
7
|
+
Project-URL: Issues, https://github.com/phil65/mkconvert/issues
|
|
8
|
+
Project-URL: Discussions, https://github.com/phil65/mkconvert/discussions
|
|
9
|
+
Project-URL: Code coverage, https://app.codecov.io/gh/phil65/mkconvert
|
|
10
|
+
Author-email: Philipp Temminghoff <philipptemminghoff@googlemail.com>
|
|
11
|
+
License: MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) 2024, Philipp Temminghoff
|
|
14
|
+
|
|
15
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
17
|
+
in the Software without restriction, including without limitation the rights
|
|
18
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
19
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
20
|
+
furnished to do so, subject to the following conditions:
|
|
21
|
+
|
|
22
|
+
The above copyright notice and this permission notice shall be included in all
|
|
23
|
+
copies or substantial portions of the Software.
|
|
24
|
+
|
|
25
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
+
SOFTWARE.
|
|
32
|
+
|
|
33
|
+
License-File: LICENSE
|
|
34
|
+
Classifier: Development Status :: 4 - Beta
|
|
35
|
+
Classifier: Framework :: Pydantic
|
|
36
|
+
Classifier: Framework :: Pydantic :: 2
|
|
37
|
+
Classifier: Intended Audience :: Developers
|
|
38
|
+
Classifier: Operating System :: OS Independent
|
|
39
|
+
Classifier: Programming Language :: Python :: 3
|
|
40
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
43
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
44
|
+
Classifier: Topic :: Documentation
|
|
45
|
+
Classifier: Topic :: Software Development
|
|
46
|
+
Classifier: Topic :: Utilities
|
|
47
|
+
Classifier: Typing :: Typed
|
|
48
|
+
Requires-Python: >=3.12
|
|
49
|
+
Requires-Dist: pydantic
|
|
50
|
+
Provides-Extra: comrak
|
|
51
|
+
Requires-Dist: comrak; (python_version < '3.14') and extra == 'comrak'
|
|
52
|
+
Provides-Extra: htmd-py
|
|
53
|
+
Requires-Dist: htmd-py; extra == 'htmd-py'
|
|
54
|
+
Provides-Extra: lxml
|
|
55
|
+
Requires-Dist: lxml; (python_version < '3.14') and extra == 'lxml'
|
|
56
|
+
Provides-Extra: markdown
|
|
57
|
+
Requires-Dist: markdown; extra == 'markdown'
|
|
58
|
+
Requires-Dist: pymdown-extensions>=10.12; extra == 'markdown'
|
|
59
|
+
Provides-Extra: markdown-it-pyrs
|
|
60
|
+
Requires-Dist: markdown-it-pyrs; extra == 'markdown-it-pyrs'
|
|
61
|
+
Provides-Extra: markdown2
|
|
62
|
+
Requires-Dist: markdown2; extra == 'markdown2'
|
|
63
|
+
Provides-Extra: markdownify
|
|
64
|
+
Requires-Dist: markdownify; extra == 'markdownify'
|
|
65
|
+
Provides-Extra: marko
|
|
66
|
+
Requires-Dist: marko; extra == 'marko'
|
|
67
|
+
Provides-Extra: mistune
|
|
68
|
+
Requires-Dist: mistune; extra == 'mistune'
|
|
69
|
+
Provides-Extra: nh3
|
|
70
|
+
Requires-Dist: nh3; extra == 'nh3'
|
|
71
|
+
Provides-Extra: pyromark
|
|
72
|
+
Requires-Dist: pyromark; (python_version < '3.14') and extra == 'pyromark'
|
|
73
|
+
Description-Content-Type: text/markdown
|
|
74
|
+
|
|
75
|
+
# mkconvert
|
|
76
|
+
|
|
77
|
+
[](https://pypi.org/project/mkconvert/)
|
|
78
|
+
[](https://pypi.org/project/mkconvert/)
|
|
79
|
+
[](https://pypi.org/project/mkconvert/)
|
|
80
|
+
[](https://pypi.org/project/mkconvert/)
|
|
81
|
+
[](https://pypi.org/project/mkconvert/)
|
|
82
|
+
[](https://pypi.org/project/mkconvert/)
|
|
83
|
+
[](https://pypi.org/project/mkconvert/)
|
|
84
|
+
[](https://pypi.org/project/mkconvert/)
|
|
85
|
+
[](https://pypi.org/project/mkconvert/)
|
|
86
|
+
[](https://github.com/phil65/mkconvert/releases)
|
|
87
|
+
[](https://github.com/phil65/mkconvert/graphs/contributors)
|
|
88
|
+
[](https://github.com/phil65/mkconvert/discussions)
|
|
89
|
+
[](https://github.com/phil65/mkconvert/forks)
|
|
90
|
+
[](https://github.com/phil65/mkconvert/issues)
|
|
91
|
+
[](https://github.com/phil65/mkconvert/pulls)
|
|
92
|
+
[](https://github.com/phil65/mkconvert/watchers)
|
|
93
|
+
[](https://github.com/phil65/mkconvert/stars)
|
|
94
|
+
[](https://github.com/phil65/mkconvert)
|
|
95
|
+
[](https://github.com/phil65/mkconvert/commits)
|
|
96
|
+
[](https://github.com/phil65/mkconvert/releases)
|
|
97
|
+
[](https://github.com/phil65/mkconvert)
|
|
98
|
+
[](https://github.com/phil65/mkconvert)
|
|
99
|
+
[](https://github.com/phil65/mkconvert)
|
|
100
|
+
[](https://github.com/phil65/mkconvert)
|
|
101
|
+
[](https://codecov.io/gh/phil65/mkconvert/)
|
|
102
|
+
[](https://github.com/psf/black)
|
|
103
|
+
[](https://pyup.io/repos/github/phil65/mkconvert/)
|
|
104
|
+
|
|
105
|
+
[Read the documentation!](https://phil65.github.io/mkconvert/)
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
| Feature | Python-Markdown | Markdown2 | Mistune | Comrak (Rust) | PyroMark (Rust) | Markdown-It-PyRS (Rust) |
|
|
109
|
+
|---------|----------------|-----------|---------|---------------|-----------------|-------------------------|
|
|
110
|
+
| **Core CommonMark** | ✅ | ✅ | ✅ | ✅ (100% compliant) | ✅ | ✅ (100% compliant) |
|
|
111
|
+
| Fenced code blocks | ✅ | ✅ (with ext) | ✅ | ✅ | ✅ | ✅ |
|
|
112
|
+
| **GitHub Flavored Markdown** |||||||
|
|
113
|
+
| Tables | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.table`) | ✅ (optional) | ✅ (with GFM or `.table`) |
|
|
114
|
+
| Task lists | ✅ (with pymdownx.tasklist) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.tasklist`) | ✅ (optional) | ✅ (with `.tasklist`) |
|
|
115
|
+
| Strikethrough | ✅ (with pymdownx.tilde) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.strikethrough`) | ✅ (optional) | ✅ (with GFM or `.strikethrough`) |
|
|
116
|
+
| Autolinks | ✅ (with pymdownx.magiclink) | ❌ | ✅ (with plugin) | ✅ (with `.autolink`) | ✅ (with GFM) | ✅ (with `.autolink_ext`) |
|
|
117
|
+
| GFM Alerts | ❌ | ❌ | ❌ | ✅ (with `.alerts`) | ✅ (with GFM) | ❌ |
|
|
118
|
+
| **Extended Features** |||||||
|
|
119
|
+
| Footnotes | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.footnotes`) | ✅ (optional) | ✅ (with `.footnote`) |
|
|
120
|
+
| Definition lists | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.description_lists`) | ✅ (optional) | ✅ (with `.deflist`) |
|
|
121
|
+
| Admonitions | ✅ (with ext) | ❌ | ❌ | ❌ | ❌ | ❌ |
|
|
122
|
+
| Math notation | ✅ (with pymdownx.arithmatex) | ❌ | ✅ (with plugin) | ✅ (with `.math_dollars`/`.math_code`) | ✅ (optional) | ❌ |
|
|
123
|
+
| Superscript | ✅ (with ext) | ❌ | ❌ | ✅ (with `.superscript`) | ✅ (optional) | ❌ |
|
|
124
|
+
| Subscript | ✅ (with ext) | ❌ | ❌ | ✅ (with `.subscript`) | ✅ (optional) | ❌ |
|
|
125
|
+
| Table of Contents | ✅ (with ext) | ✅ (with ext) | ❌ | ❌ | ❌ | ❌ |
|
|
126
|
+
| Front matter | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.front_matter_delimiter`) | ✅ (optional) | ✅ (with `.front_matter`) |
|
|
127
|
+
| Wikilinks | ✅ (with ext) | ❌ | ❌ | ✅ (with `.wikilinks_*`) | ✅ (optional) | ❌ |
|
|
128
|
+
| Header IDs | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.header_ids`) | ✅ (optional) | ✅ (with `.heading_anchors`) |
|
|
129
|
+
| Multiline blockquotes | ❌ | ❌ | ❌ | ✅ (with `.multiline_block_quotes`) | ❌ | ❌ |
|
|
130
|
+
| Syntax highlighting | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with plugins) | ❌ | ❌ |
|
|
131
|
+
| Special features | Admonitions | Smart quotes | Custom renderers | Spoiler, Greentext | Definition lists | Tree structure, very fast (20x faster than Python-Markdown) |
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# mkconvert
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/mkconvert/)
|
|
4
|
+
[](https://pypi.org/project/mkconvert/)
|
|
5
|
+
[](https://pypi.org/project/mkconvert/)
|
|
6
|
+
[](https://pypi.org/project/mkconvert/)
|
|
7
|
+
[](https://pypi.org/project/mkconvert/)
|
|
8
|
+
[](https://pypi.org/project/mkconvert/)
|
|
9
|
+
[](https://pypi.org/project/mkconvert/)
|
|
10
|
+
[](https://pypi.org/project/mkconvert/)
|
|
11
|
+
[](https://pypi.org/project/mkconvert/)
|
|
12
|
+
[](https://github.com/phil65/mkconvert/releases)
|
|
13
|
+
[](https://github.com/phil65/mkconvert/graphs/contributors)
|
|
14
|
+
[](https://github.com/phil65/mkconvert/discussions)
|
|
15
|
+
[](https://github.com/phil65/mkconvert/forks)
|
|
16
|
+
[](https://github.com/phil65/mkconvert/issues)
|
|
17
|
+
[](https://github.com/phil65/mkconvert/pulls)
|
|
18
|
+
[](https://github.com/phil65/mkconvert/watchers)
|
|
19
|
+
[](https://github.com/phil65/mkconvert/stars)
|
|
20
|
+
[](https://github.com/phil65/mkconvert)
|
|
21
|
+
[](https://github.com/phil65/mkconvert/commits)
|
|
22
|
+
[](https://github.com/phil65/mkconvert/releases)
|
|
23
|
+
[](https://github.com/phil65/mkconvert)
|
|
24
|
+
[](https://github.com/phil65/mkconvert)
|
|
25
|
+
[](https://github.com/phil65/mkconvert)
|
|
26
|
+
[](https://github.com/phil65/mkconvert)
|
|
27
|
+
[](https://codecov.io/gh/phil65/mkconvert/)
|
|
28
|
+
[](https://github.com/psf/black)
|
|
29
|
+
[](https://pyup.io/repos/github/phil65/mkconvert/)
|
|
30
|
+
|
|
31
|
+
[Read the documentation!](https://phil65.github.io/mkconvert/)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
| Feature | Python-Markdown | Markdown2 | Mistune | Comrak (Rust) | PyroMark (Rust) | Markdown-It-PyRS (Rust) |
|
|
35
|
+
|---------|----------------|-----------|---------|---------------|-----------------|-------------------------|
|
|
36
|
+
| **Core CommonMark** | ✅ | ✅ | ✅ | ✅ (100% compliant) | ✅ | ✅ (100% compliant) |
|
|
37
|
+
| Fenced code blocks | ✅ | ✅ (with ext) | ✅ | ✅ | ✅ | ✅ |
|
|
38
|
+
| **GitHub Flavored Markdown** |||||||
|
|
39
|
+
| Tables | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.table`) | ✅ (optional) | ✅ (with GFM or `.table`) |
|
|
40
|
+
| Task lists | ✅ (with pymdownx.tasklist) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.tasklist`) | ✅ (optional) | ✅ (with `.tasklist`) |
|
|
41
|
+
| Strikethrough | ✅ (with pymdownx.tilde) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.strikethrough`) | ✅ (optional) | ✅ (with GFM or `.strikethrough`) |
|
|
42
|
+
| Autolinks | ✅ (with pymdownx.magiclink) | ❌ | ✅ (with plugin) | ✅ (with `.autolink`) | ✅ (with GFM) | ✅ (with `.autolink_ext`) |
|
|
43
|
+
| GFM Alerts | ❌ | ❌ | ❌ | ✅ (with `.alerts`) | ✅ (with GFM) | ❌ |
|
|
44
|
+
| **Extended Features** |||||||
|
|
45
|
+
| Footnotes | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with `.footnotes`) | ✅ (optional) | ✅ (with `.footnote`) |
|
|
46
|
+
| Definition lists | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.description_lists`) | ✅ (optional) | ✅ (with `.deflist`) |
|
|
47
|
+
| Admonitions | ✅ (with ext) | ❌ | ❌ | ❌ | ❌ | ❌ |
|
|
48
|
+
| Math notation | ✅ (with pymdownx.arithmatex) | ❌ | ✅ (with plugin) | ✅ (with `.math_dollars`/`.math_code`) | ✅ (optional) | ❌ |
|
|
49
|
+
| Superscript | ✅ (with ext) | ❌ | ❌ | ✅ (with `.superscript`) | ✅ (optional) | ❌ |
|
|
50
|
+
| Subscript | ✅ (with ext) | ❌ | ❌ | ✅ (with `.subscript`) | ✅ (optional) | ❌ |
|
|
51
|
+
| Table of Contents | ✅ (with ext) | ✅ (with ext) | ❌ | ❌ | ❌ | ❌ |
|
|
52
|
+
| Front matter | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.front_matter_delimiter`) | ✅ (optional) | ✅ (with `.front_matter`) |
|
|
53
|
+
| Wikilinks | ✅ (with ext) | ❌ | ❌ | ✅ (with `.wikilinks_*`) | ✅ (optional) | ❌ |
|
|
54
|
+
| Header IDs | ✅ (with ext) | ✅ (with ext) | ❌ | ✅ (with `.header_ids`) | ✅ (optional) | ✅ (with `.heading_anchors`) |
|
|
55
|
+
| Multiline blockquotes | ❌ | ❌ | ❌ | ✅ (with `.multiline_block_quotes`) | ❌ | ❌ |
|
|
56
|
+
| Syntax highlighting | ✅ (with ext) | ✅ (with ext) | ✅ (with plugin) | ✅ (with plugins) | ❌ | ❌ |
|
|
57
|
+
| Special features | Admonitions | Smart quotes | Custom renderers | Spoiler, Greentext | Definition lists | Tree structure, very fast (20x faster than Python-Markdown) |
|
|
File without changes
|