mknodes 2.1.0__tar.gz → 2.2.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.
- {mknodes-2.1.0 → mknodes-2.2.0}/PKG-INFO +1 -1
- {mknodes-2.1.0 → mknodes-2.2.0}/pyproject.toml +4 -1
- mknodes-2.2.0/src/mknodes/mdext/README.md +240 -0
- mknodes-2.2.0/src/mknodes/mdext/__init__.py +7 -0
- mknodes-2.2.0/src/mknodes/mdext/config_examples.py +322 -0
- mknodes-2.2.0/src/mknodes/mdext/examples.py +316 -0
- mknodes-2.2.0/src/mknodes/mdext/mknodes_ext.py +166 -0
- mknodes-2.2.0/src/mknodes/mdext/performance_test.py +211 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/LICENSE +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/README.md +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/__main__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/_mkdocstrings/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/_mkdocstrings/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkadmonition/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkadmonition/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkannotations/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkannotations/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkbasetable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkbinaryimage/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkbinaryimage/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkblock/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkblockquote/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkblockquote/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcard/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcard/grid.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcard/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkclidoc/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkclidoc/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcode/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcode/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcompactadmonition/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcompactadmonition/compactadmonition.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcompactadmonition/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcontainer/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcontainer/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcritic/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkcritic/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdataclassinfo/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdataclassinfo/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdefinitionlist/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdefinitionlist/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdetailsblock/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdetailsblock/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdiagram/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkdiagram/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkfootnotes/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkfootnotes/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkheader/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkheader/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkhtmlblock/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkhtmlblock/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkhtmltable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkhtmltable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkicon/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkicon/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkiframe/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkiframe/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimage/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimage/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimagecompare/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimagecompare/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimageslideshow/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkimageslideshow/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkjupyterlite/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkjupyterlite/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkkeys/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkkeys/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mklink/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mklink/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mklist/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mklist/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkmaterialbadge/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkmaterialbadge/materialbadge.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkmaterialbadge/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mknode/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkprogressbar/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkprogressbar/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkprogressbar/progressbar.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkpyodide/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkpyodide/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkpyscript/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkpyscript/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkshowcase/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkshowcase/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkspeechbubble/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkspeechbubble/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mkspeechbubble/speechbubble.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabbed/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabbed/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabbedblocks/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabbedblocks/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabcontainer.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabs/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktabs/mktab.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktasklist/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktasklist/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktext/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktext/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktimeline/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktimeline/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktimeline/timeline.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/mktimeline/timeline.js +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/basenodes/processors/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/build/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/build/builder.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/build/exporter.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/build/output.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/cli/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/admonition.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/badges.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/buildsystems.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/commitconventions.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/datatypes.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/eventplugins.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/fences.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/installmethods.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/taskrunners.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/tools.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/data/treestyles.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkcodeimage/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkcodeimage/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkgrid/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkgrid/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkprettyprint/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mkprettyprint/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mksnippet/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/extranodes/mksnippet/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/configfile.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/contexts.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/folderinfo.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/gitrepository.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/grifferegistry.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/license.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/linkprovider.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/mkdocsconfigfile.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/nodefile.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/packageinfo.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/packageregistry.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/parse_deps.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/pyproject.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/info/reporegistry.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/jinja/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/jinja/filters.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/jinja/nodeenvironment.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/a_quick_tour.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/dev_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/get_started_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/github_index.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/navs_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/nodes_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/page_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/root.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/routing.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/standalone.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/manual/templating_section.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/mdlib/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/mdlib/mdconverter.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/mkclinav.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/mkdoc.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/mknav.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/navbuilder.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/navigation.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/navparser.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/navrouter.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/navs/router.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/mod.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/modmanager.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/parallax.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/parallax.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/scrollreveal.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/nodemods/scrollreveal.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/metadata.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkclasspage/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkclasspage/classpage.md +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkclasspage/classpage_tabbed.md +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkmodulepage/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkmodulepage/modulepage.md +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mkpage.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/mktemplatepage.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/pagetemplate.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/templateblocks.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/templateregistry.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/pages/toc.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/paths.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/py.typed +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/css/animated.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/css/hero.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/css/material_css_extra.jinja +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/css/theme_material.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/css/theme_mkdocs.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/filters.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/js/tablesort.js +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/python_objects.inv +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_black.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_coverage.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_mkdocs.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_mypy.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_precommit.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_pyright.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/resources/toolfiles/tool_ruff.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkbadge/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkbadge/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkchangelog/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkchangelog/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkclassdiagram/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkclassdiagram/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkclasstable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkclasstable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcodeofconduct/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcodeofconduct/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommandoutput/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommandoutput/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommandoutput/terminal.css +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommentedcode/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommentedcode/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommitconventions/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkcommitconventions/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkconfigsetting/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkconfigsetting/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdependencygroups/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdependencygroups/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdependencytable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdependencytable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdevenvsetup/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdevenvsetup/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdevtools/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkdevtools/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkinclude/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkinclude/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkinstallguide/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkinstallguide/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mklicense/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mklicense/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkllm/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkllm/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkmetadatabadges/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkmetadatabadges/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkmoduletable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkmoduletable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpipdeptree/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpipdeptree/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpluginflow/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpluginflow/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpydeps/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkpydeps/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkreprrawrendered/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkreprrawrendered/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkshields/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mkshields/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktemplate/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktemplate/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktemplatetable/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktemplatetable/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktreeview/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/templatenodes/mktreeview/metadata.toml +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/theme/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/theme/colortheme.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/theme/materialtheme/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/theme/materialtheme/palette.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/theme/theme.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/treelib/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/treelib/treeprint.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/__init__.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/annotationappender.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/classhelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/color.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/connector.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/coroutines.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/downloadhelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/helpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/icons.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/inspecthelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/inventorymanager.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/linkreplacer.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/log.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/packagehelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/pathhelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/reprhelpers.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/resources.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/superdict.py +0 -0
- {mknodes-2.1.0 → mknodes-2.2.0}/src/mknodes/utils/xmlhelpers.py +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[project]
|
|
4
4
|
name = "mknodes"
|
|
5
|
-
version = "2.
|
|
5
|
+
version = "2.2.0"
|
|
6
6
|
description = "Don't write docs. Code them."
|
|
7
7
|
readme = "README.md"
|
|
8
8
|
requires-python = ">=3.13"
|
|
@@ -83,6 +83,9 @@ mknodes = "mknodes.cli:main"
|
|
|
83
83
|
[project.entry-points."jinjarope.environment"]
|
|
84
84
|
mknodes = "mknodes.jinja:setup_env"
|
|
85
85
|
|
|
86
|
+
[project.entry-points."markdown.extensions"]
|
|
87
|
+
mknodes = "mknodes.mdext:makeExtension"
|
|
88
|
+
|
|
86
89
|
[dependency-groups]
|
|
87
90
|
dev = [
|
|
88
91
|
# black is used by mkdocstrings to format signatures
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# MkNodes Markdown Extension
|
|
2
|
+
|
|
3
|
+
A markdown extension that allows rendering Jinja templates using MkNodes components within markdown documents.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The MkNodes markdown extension enables you to embed dynamic content generation directly in your markdown files using the `/// mknodes` block syntax.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
The extension is included with the MkNodes package:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pip install mknodes
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
### MkDocs Configuration
|
|
20
|
+
|
|
21
|
+
```yaml
|
|
22
|
+
# mkdocs.yml
|
|
23
|
+
markdown_extensions:
|
|
24
|
+
- mknodes.mdext
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Markdown Usage
|
|
28
|
+
|
|
29
|
+
```markdown
|
|
30
|
+
# My Document
|
|
31
|
+
|
|
32
|
+
/// mknodes
|
|
33
|
+
{{ "Dynamic Header" | MkHeader(level=2) }}
|
|
34
|
+
{{ mk.MkAdmonition(content="Generated content!", typ="info") }}
|
|
35
|
+
{{ 75 | MkProgressBar }}
|
|
36
|
+
///
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Configuration
|
|
40
|
+
|
|
41
|
+
### The `context` Option
|
|
42
|
+
|
|
43
|
+
The extension has a single boolean option `context` that controls whether to create a full project context:
|
|
44
|
+
|
|
45
|
+
| Setting | Performance | Use Case |
|
|
46
|
+
|---------|-------------|----------|
|
|
47
|
+
| `context: false` (default) | **~50x faster** | Most use cases, simple content |
|
|
48
|
+
| `context: true` | Slower | When you need full project metadata |
|
|
49
|
+
|
|
50
|
+
#### MkDocs Configuration
|
|
51
|
+
|
|
52
|
+
```yaml
|
|
53
|
+
# Default - no context (fast)
|
|
54
|
+
markdown_extensions:
|
|
55
|
+
- mknodes.mdext
|
|
56
|
+
|
|
57
|
+
# With full context (when needed)
|
|
58
|
+
markdown_extensions:
|
|
59
|
+
- mknodes.mdext:
|
|
60
|
+
context: true
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
#### Programmatic Configuration
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
import markdown
|
|
67
|
+
from mknodes.mdext import makeExtension
|
|
68
|
+
|
|
69
|
+
# Default (fast)
|
|
70
|
+
md = markdown.Markdown(extensions=[makeExtension()])
|
|
71
|
+
|
|
72
|
+
# With full context
|
|
73
|
+
md = markdown.Markdown(extensions=[makeExtension(context=True)])
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Per-Block Context
|
|
77
|
+
|
|
78
|
+
You can enable full context for specific blocks using the `| context` argument:
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
## Fast content (default)
|
|
82
|
+
/// mknodes
|
|
83
|
+
{{ "Quick render" | MkHeader(level=2) }}
|
|
84
|
+
///
|
|
85
|
+
|
|
86
|
+
## Content needing full context
|
|
87
|
+
/// mknodes | context
|
|
88
|
+
{{ "With project metadata" | MkHeader(level=2) }}
|
|
89
|
+
///
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Syntax
|
|
93
|
+
|
|
94
|
+
### Filter Syntax
|
|
95
|
+
|
|
96
|
+
```markdown
|
|
97
|
+
/// mknodes
|
|
98
|
+
{{ "Title" | MkHeader(level=2) }}
|
|
99
|
+
{{ "Some text" | MkText }}
|
|
100
|
+
{{ 85 | MkProgressBar }}
|
|
101
|
+
///
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Direct Calls
|
|
105
|
+
|
|
106
|
+
```markdown
|
|
107
|
+
/// mknodes
|
|
108
|
+
{{ mk.MkAdmonition(content="Important!", typ="warning") }}
|
|
109
|
+
{{ mk.MkCode(content="print('hello')", language="python") }}
|
|
110
|
+
{{ mk.MkTable([["Name", "Value"], ["foo", "bar"]]) }}
|
|
111
|
+
///
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Jinja Features
|
|
115
|
+
|
|
116
|
+
```markdown
|
|
117
|
+
/// mknodes
|
|
118
|
+
{% for i in range(3) %}
|
|
119
|
+
{{ ("Item " ~ (i + 1)) | MkText }}
|
|
120
|
+
{% endfor %}
|
|
121
|
+
///
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Available Components
|
|
125
|
+
|
|
126
|
+
All MkNodes components are available:
|
|
127
|
+
|
|
128
|
+
- **Text**: `MkText`, `MkHeader`
|
|
129
|
+
- **Code**: `MkCode` (with syntax highlighting)
|
|
130
|
+
- **Admonitions**: `MkAdmonition` (info, warning, error, success, etc.)
|
|
131
|
+
- **Data**: `MkTable`, `MkList`, `MkDefinitionList`
|
|
132
|
+
- **Interactive**: `MkProgressBar`, `MkTabs`, `MkDetails`
|
|
133
|
+
- **And many more...**
|
|
134
|
+
|
|
135
|
+
## Performance
|
|
136
|
+
|
|
137
|
+
The default `context=false` setting is approximately **50x faster** than `context=true`:
|
|
138
|
+
|
|
139
|
+
| Setting | Typical Render Time |
|
|
140
|
+
|---------|---------------------|
|
|
141
|
+
| `context=false` | ~0.04s |
|
|
142
|
+
| `context=true` | ~2.0s |
|
|
143
|
+
|
|
144
|
+
**Recommendation**: Use the default (`context=false`) unless you specifically need project metadata.
|
|
145
|
+
|
|
146
|
+
## Examples
|
|
147
|
+
|
|
148
|
+
### Basic Content
|
|
149
|
+
|
|
150
|
+
```markdown
|
|
151
|
+
/// mknodes
|
|
152
|
+
{{ "Welcome" | MkHeader(level=1) }}
|
|
153
|
+
{{ mk.MkAdmonition(content="Hello World!", typ="success") }}
|
|
154
|
+
///
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Tables
|
|
158
|
+
|
|
159
|
+
```markdown
|
|
160
|
+
/// mknodes
|
|
161
|
+
{{ mk.MkTable([
|
|
162
|
+
["Feature", "Status"],
|
|
163
|
+
["Headers", "✅"],
|
|
164
|
+
["Tables", "✅"],
|
|
165
|
+
["Code", "✅"]
|
|
166
|
+
]) }}
|
|
167
|
+
///
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Code Blocks
|
|
171
|
+
|
|
172
|
+
```markdown
|
|
173
|
+
/// mknodes
|
|
174
|
+
{{ mk.MkCode(content="def hello():\n return 'world'", language="python") }}
|
|
175
|
+
///
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Progress Indicators
|
|
179
|
+
|
|
180
|
+
```markdown
|
|
181
|
+
/// mknodes
|
|
182
|
+
{{ "Completion: " | MkText }}{{ 100 | MkProgressBar }}
|
|
183
|
+
{{ "In Progress: " | MkText }}{{ 60 | MkProgressBar }}
|
|
184
|
+
///
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## Integration with Other Extensions
|
|
188
|
+
|
|
189
|
+
```yaml
|
|
190
|
+
markdown_extensions:
|
|
191
|
+
- mknodes.mdext
|
|
192
|
+
- admonition
|
|
193
|
+
- pymdownx.superfences
|
|
194
|
+
- pymdownx.highlight
|
|
195
|
+
- tables
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Error Handling
|
|
199
|
+
|
|
200
|
+
When a template fails, a visible error is displayed:
|
|
201
|
+
|
|
202
|
+
```html
|
|
203
|
+
<div class="mknodes-error">
|
|
204
|
+
MkNodes rendering error: [error message]
|
|
205
|
+
</div>
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## Troubleshooting
|
|
209
|
+
|
|
210
|
+
### Block not recognized
|
|
211
|
+
|
|
212
|
+
Ensure proper spacing around the block:
|
|
213
|
+
|
|
214
|
+
```markdown
|
|
215
|
+
Regular paragraph.
|
|
216
|
+
|
|
217
|
+
/// mknodes
|
|
218
|
+
{{ "Content" | MkHeader }}
|
|
219
|
+
///
|
|
220
|
+
|
|
221
|
+
Another paragraph.
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Component errors
|
|
225
|
+
|
|
226
|
+
Check parameter names match the component's constructor:
|
|
227
|
+
|
|
228
|
+
```markdown
|
|
229
|
+
/// mknodes
|
|
230
|
+
{{ mk.MkCode(content="code here", language="python") }}
|
|
231
|
+
///
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Performance issues
|
|
235
|
+
|
|
236
|
+
Use the default `context=false` setting. Only use `context=true` or `| context` when you specifically need project metadata.
|
|
237
|
+
|
|
238
|
+
## License
|
|
239
|
+
|
|
240
|
+
Part of the MkNodes project.
|
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
"""Configuration examples for MkNodes markdown extension.
|
|
2
|
+
|
|
3
|
+
This file demonstrates the different ways to configure the context option
|
|
4
|
+
for the MkNodes extension, both globally via mkdocs.yml and per-block.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from __future__ import annotations
|
|
8
|
+
|
|
9
|
+
import markdown
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def mkdocs_yml_examples():
|
|
13
|
+
"""Show how to configure the extension in mkdocs.yml."""
|
|
14
|
+
print("=== MkDocs YAML Configuration Examples ===")
|
|
15
|
+
print("""
|
|
16
|
+
# mkdocs.yml - Default (no context, fast)
|
|
17
|
+
markdown_extensions:
|
|
18
|
+
- mknodes.mdext
|
|
19
|
+
|
|
20
|
+
# mkdocs.yml - With full context (expensive)
|
|
21
|
+
markdown_extensions:
|
|
22
|
+
- mknodes.mdext:
|
|
23
|
+
context: true
|
|
24
|
+
|
|
25
|
+
# mkdocs.yml - Explicit no context (default behavior)
|
|
26
|
+
markdown_extensions:
|
|
27
|
+
- mknodes.mdext:
|
|
28
|
+
context: false
|
|
29
|
+
|
|
30
|
+
# mkdocs.yml - Combined with other extensions
|
|
31
|
+
markdown_extensions:
|
|
32
|
+
- admonition
|
|
33
|
+
- pymdownx.superfences
|
|
34
|
+
- pymdownx.tabbed
|
|
35
|
+
- tables
|
|
36
|
+
- mknodes.mdext:
|
|
37
|
+
context: false # Fast rendering (default)
|
|
38
|
+
""")
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
def per_block_examples():
|
|
42
|
+
"""Demonstrate per-block context mode configuration."""
|
|
43
|
+
print("=== Per-Block Configuration Examples ===")
|
|
44
|
+
|
|
45
|
+
# Example markdown with different block modes
|
|
46
|
+
markdown_content = """
|
|
47
|
+
# Per-Block Context Demo
|
|
48
|
+
|
|
49
|
+
## Default Mode (uses global config)
|
|
50
|
+
/// mknodes
|
|
51
|
+
{{ "Default" | MkHeader(level=3) }}
|
|
52
|
+
{{ mk.MkAdmonition(content="Uses the globally configured context setting", typ="info") }}
|
|
53
|
+
///
|
|
54
|
+
|
|
55
|
+
## No Context (fast, default)
|
|
56
|
+
/// mknodes
|
|
57
|
+
{{ "Fast Rendering" | MkHeader(level=3) }}
|
|
58
|
+
{{ mk.MkAdmonition(content="This block uses no context for speed", typ="success") }}
|
|
59
|
+
{{ 85 | MkProgressBar }}
|
|
60
|
+
///
|
|
61
|
+
|
|
62
|
+
## With Full Context
|
|
63
|
+
/// mknodes | context
|
|
64
|
+
{{ "Full Context" | MkHeader(level=3) }}
|
|
65
|
+
{{ mk.MkAdmonition(content="This block uses full context with all features", typ="warning") }}
|
|
66
|
+
{{ mk.MkCode(content="print('Full context available!')", language="python") }}
|
|
67
|
+
///
|
|
68
|
+
"""
|
|
69
|
+
|
|
70
|
+
from mknodes.mdext import makeExtension
|
|
71
|
+
|
|
72
|
+
# Test with default config (no context)
|
|
73
|
+
print("Testing with default config + per-block overrides:")
|
|
74
|
+
md = markdown.Markdown(extensions=[makeExtension()])
|
|
75
|
+
result = md.convert(markdown_content)
|
|
76
|
+
|
|
77
|
+
print("✅ Rendered successfully with mixed context settings")
|
|
78
|
+
print(f"Result length: {len(result)} characters")
|
|
79
|
+
print("\n" + "=" * 60 + "\n")
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
def programmatic_examples():
|
|
83
|
+
"""Show programmatic configuration examples."""
|
|
84
|
+
print("=== Programmatic Configuration Examples ===")
|
|
85
|
+
|
|
86
|
+
simple_content = """
|
|
87
|
+
/// mknodes
|
|
88
|
+
{{ "Programmatic Test" | MkHeader(level=2) }}
|
|
89
|
+
{{ mk.MkAdmonition(content="Testing programmatic configuration", typ="info") }}
|
|
90
|
+
///
|
|
91
|
+
"""
|
|
92
|
+
|
|
93
|
+
from mknodes.mdext import makeExtension
|
|
94
|
+
|
|
95
|
+
print("1. Extension with default (no context, fast):")
|
|
96
|
+
md1 = markdown.Markdown(extensions=[makeExtension()])
|
|
97
|
+
md1.convert(simple_content)
|
|
98
|
+
print("✅ Configured with context=False (default)")
|
|
99
|
+
|
|
100
|
+
print("\n2. Extension with explicit context=False:")
|
|
101
|
+
md2 = markdown.Markdown(extensions=[makeExtension(context=False)])
|
|
102
|
+
md2.convert(simple_content)
|
|
103
|
+
print("✅ Configured with context=False")
|
|
104
|
+
|
|
105
|
+
print("\n3. Extension with context=True (full context):")
|
|
106
|
+
md3 = markdown.Markdown(extensions=[makeExtension(context=True)])
|
|
107
|
+
md3.convert(simple_content)
|
|
108
|
+
print("✅ Configured with context=True")
|
|
109
|
+
|
|
110
|
+
print("\n4. Multiple extensions with MkNodes:")
|
|
111
|
+
md4 = markdown.Markdown(
|
|
112
|
+
extensions=[
|
|
113
|
+
"admonition",
|
|
114
|
+
"pymdownx.superfences",
|
|
115
|
+
"tables",
|
|
116
|
+
makeExtension(), # Default: no context
|
|
117
|
+
]
|
|
118
|
+
)
|
|
119
|
+
md4.convert(simple_content)
|
|
120
|
+
print("✅ Configured with multiple extensions")
|
|
121
|
+
|
|
122
|
+
print("\n" + "=" * 60 + "\n")
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
def performance_scenario_examples():
|
|
126
|
+
"""Show examples for different performance scenarios."""
|
|
127
|
+
print("=== Performance Scenario Examples ===")
|
|
128
|
+
|
|
129
|
+
scenarios = [
|
|
130
|
+
{
|
|
131
|
+
"name": "Development Environment (needs full context)",
|
|
132
|
+
"config": "context: true",
|
|
133
|
+
"reason": "Complete functionality needed during development",
|
|
134
|
+
"yaml": """
|
|
135
|
+
markdown_extensions:
|
|
136
|
+
- mknodes.mdext:
|
|
137
|
+
context: true
|
|
138
|
+
""",
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "Production Website",
|
|
142
|
+
"config": "context: false (default)",
|
|
143
|
+
"reason": "Fast rendering for better user experience",
|
|
144
|
+
"yaml": """
|
|
145
|
+
markdown_extensions:
|
|
146
|
+
- mknodes.mdext
|
|
147
|
+
""",
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "CI/CD Documentation Build",
|
|
151
|
+
"config": "context: false (default)",
|
|
152
|
+
"reason": "Faster build times in automated pipelines",
|
|
153
|
+
"yaml": """
|
|
154
|
+
markdown_extensions:
|
|
155
|
+
- mknodes.mdext
|
|
156
|
+
""",
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"name": "Mixed Content Site",
|
|
160
|
+
"config": "default + per-block context",
|
|
161
|
+
"reason": "Default fast rendering with per-block full context when needed",
|
|
162
|
+
"yaml": """
|
|
163
|
+
markdown_extensions:
|
|
164
|
+
- mknodes.mdext
|
|
165
|
+
""",
|
|
166
|
+
"markdown": """
|
|
167
|
+
# Mixed content example
|
|
168
|
+
|
|
169
|
+
## Fast content (default)
|
|
170
|
+
/// mknodes
|
|
171
|
+
{{ "Quick render" | MkHeader(level=3) }}
|
|
172
|
+
///
|
|
173
|
+
|
|
174
|
+
## Complex content (when full context needed)
|
|
175
|
+
/// mknodes | context
|
|
176
|
+
{{ "Rich content with full context" | MkHeader(level=3) }}
|
|
177
|
+
///
|
|
178
|
+
""",
|
|
179
|
+
},
|
|
180
|
+
]
|
|
181
|
+
|
|
182
|
+
for scenario in scenarios:
|
|
183
|
+
print(f"**{scenario['name']}**")
|
|
184
|
+
print(f"Context mode: {scenario['config']}")
|
|
185
|
+
print(f"Reason: {scenario['reason']}")
|
|
186
|
+
print("mkdocs.yml configuration:")
|
|
187
|
+
print(scenario["yaml"])
|
|
188
|
+
if "markdown" in scenario:
|
|
189
|
+
print("Markdown example:")
|
|
190
|
+
print(scenario["markdown"])
|
|
191
|
+
print("-" * 40)
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
def real_world_examples():
|
|
195
|
+
"""Show real-world configuration examples."""
|
|
196
|
+
print("=== Real-World Configuration Examples ===")
|
|
197
|
+
|
|
198
|
+
examples = {
|
|
199
|
+
"Personal Blog": {
|
|
200
|
+
"description": "Simple blog with occasional dynamic content",
|
|
201
|
+
"mkdocs_yml": """
|
|
202
|
+
site_name: My Personal Blog
|
|
203
|
+
markdown_extensions:
|
|
204
|
+
- admonition
|
|
205
|
+
- pymdownx.superfences
|
|
206
|
+
- mknodes.mdext # Default: no context (fast)
|
|
207
|
+
""",
|
|
208
|
+
"usage": "Most content is static, MkNodes used for simple dynamic elements",
|
|
209
|
+
},
|
|
210
|
+
"API Documentation": {
|
|
211
|
+
"description": "Complex documentation with lots of generated content",
|
|
212
|
+
"mkdocs_yml": """
|
|
213
|
+
site_name: API Documentation
|
|
214
|
+
markdown_extensions:
|
|
215
|
+
- admonition
|
|
216
|
+
- pymdownx.superfences
|
|
217
|
+
- pymdownx.tabbed
|
|
218
|
+
- tables
|
|
219
|
+
- mknodes.mdext:
|
|
220
|
+
context: true # Need all features
|
|
221
|
+
""",
|
|
222
|
+
"usage": "Heavy use of MkNodes for API examples, tables, code blocks",
|
|
223
|
+
},
|
|
224
|
+
"Corporate Website": {
|
|
225
|
+
"description": "High-traffic site needing fast performance",
|
|
226
|
+
"mkdocs_yml": """
|
|
227
|
+
site_name: Corporate Website
|
|
228
|
+
markdown_extensions:
|
|
229
|
+
- admonition
|
|
230
|
+
- pymdownx.superfences
|
|
231
|
+
- mknodes.mdext # Default: no context (fast)
|
|
232
|
+
""",
|
|
233
|
+
"usage": "Performance is key, use per-block '| context' only when needed",
|
|
234
|
+
},
|
|
235
|
+
"Development Docs": {
|
|
236
|
+
"description": "Internal documentation with rich content",
|
|
237
|
+
"mkdocs_yml": """
|
|
238
|
+
site_name: Development Documentation
|
|
239
|
+
markdown_extensions:
|
|
240
|
+
- admonition
|
|
241
|
+
- pymdownx.superfences
|
|
242
|
+
- pymdownx.tabbed
|
|
243
|
+
- pymdownx.highlight
|
|
244
|
+
- tables
|
|
245
|
+
- toc
|
|
246
|
+
- mknodes.mdext:
|
|
247
|
+
context: true # All features available
|
|
248
|
+
""",
|
|
249
|
+
"usage": "Internal use, full functionality more important than performance",
|
|
250
|
+
},
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
for name, config in examples.items():
|
|
254
|
+
print(f"**{name}**")
|
|
255
|
+
print(f"Description: {config['description']}")
|
|
256
|
+
print("Configuration:")
|
|
257
|
+
print(config["mkdocs_yml"])
|
|
258
|
+
print(f"Usage pattern: {config['usage']}")
|
|
259
|
+
print("-" * 50)
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
def migration_examples():
|
|
263
|
+
"""Show how to migrate from old configurations."""
|
|
264
|
+
print("=== Migration Examples ===")
|
|
265
|
+
|
|
266
|
+
print("""
|
|
267
|
+
**Default behavior (no context, fast):**
|
|
268
|
+
|
|
269
|
+
mkdocs.yml:
|
|
270
|
+
```yaml
|
|
271
|
+
markdown_extensions:
|
|
272
|
+
- mknodes.mdext
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
**With full context (when needed):**
|
|
276
|
+
|
|
277
|
+
```yaml
|
|
278
|
+
markdown_extensions:
|
|
279
|
+
- mknodes.mdext:
|
|
280
|
+
context: true
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
**Mixed approach (default fast, per-block context when needed):**
|
|
284
|
+
|
|
285
|
+
mkdocs.yml:
|
|
286
|
+
```yaml
|
|
287
|
+
markdown_extensions:
|
|
288
|
+
- mknodes.mdext # Default: context=false
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
Then use per-block context when needed:
|
|
292
|
+
```markdown
|
|
293
|
+
/// mknodes | context
|
|
294
|
+
{{ "Complex content needing full context" | MkHeader }}
|
|
295
|
+
///
|
|
296
|
+
```
|
|
297
|
+
""")
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
if __name__ == "__main__":
|
|
301
|
+
print("MkNodes Extension Configuration Guide")
|
|
302
|
+
print("=" * 50)
|
|
303
|
+
|
|
304
|
+
try:
|
|
305
|
+
mkdocs_yml_examples()
|
|
306
|
+
per_block_examples()
|
|
307
|
+
programmatic_examples()
|
|
308
|
+
performance_scenario_examples()
|
|
309
|
+
real_world_examples()
|
|
310
|
+
migration_examples()
|
|
311
|
+
|
|
312
|
+
print("✅ All configuration examples completed!")
|
|
313
|
+
print("\nRecommendation:")
|
|
314
|
+
print("- Default (context=false) is ~50x faster - use for most cases")
|
|
315
|
+
print("- Use context=true only when you need full project info")
|
|
316
|
+
print("- Use '/// mknodes | context' for per-block full context")
|
|
317
|
+
|
|
318
|
+
except Exception as e: # noqa: BLE001
|
|
319
|
+
print(f"❌ Error in configuration examples: {e}")
|
|
320
|
+
import traceback
|
|
321
|
+
|
|
322
|
+
traceback.print_exc()
|