Saravanan666/pypi-org huggingface dataset:
Package: mdformat_admon
mdformat-admonAnmdformatplugin foradmonitions, a set of helpers for supporting new admonition syntaxes, and tool for rendering admonition HTML.mdformatUsageAdd this package wherever you usemdformatand the plugin will be auto-recognized. No additional configuration necessary. Seeadditional information onmdformatplugins herePre-Commitrepos:-repo:https://github.com/executablebooks/mdformatrev:0.7.16hooks:-id:mdformatadditional_dependencies:-mdformat-admonpipxpipxinstallmdformat
pipxinjectmdformatmdformat-admonHTML RenderingTo generate HTML output,python_markdown_admon_plugincan be imported frommdit_plugins. More plugins can be added in the future as appropriate.frommarkdown_itimportMarkdownItfrommdformat_admon.mdit_pluginsimportpython_markdown_admon_pluginmd=MarkdownIt("commonmark")md.use(python_markdown_admon_plugin)text='!!! note ""\n*content*'md.render(text)# <div class="admonition note"># <p><em>content</em></p># </div>ExtensibilityBecause admonition syntax varies wildly between implementations, this package provides a set of helpers for building new admonition parsers undermdformat_admon.factories.Supported bymdformat-admonpython-markdownSupported by other packagesmdformat-mkdocsMKDocsCurrently Unsupported (or at least not known to be supported)GithubMySTRemark-Admonitionspymdown-extensionsreStructuredText(Note: this pluginmay breakthese admonitions by removing or modifying indentation)Obsidian Callouts(Note: this pluginmay breakthese admonitions by adding extra characters)See the example test file:./tests/pre-commit-test.mdContributingSeeCONTRIBUTING.md
Package: mdformat-beautysh
mdformat-beautyshMdformat plugin to beautify Bash scriptsDescriptionmdformat-beautysh is anmdformatplugin
that makes mdformat format Bash scripts withBeautysh.UsageInstall with:pipinstallmdformat-beautyshWhen using mdformat on the command line, Beautysh formatting will be automatically enabled after install.When using mdformat Python API, code formatting for Bash scripts will have to be enabled explicitly:importmdformatunformatted="""```bashfunction bad_func(){echo "test"}```"""formatted=mdformat.text(unformatted,codeformatters={"bash","sh"})assertformatted=="""```bashfunction bad_func(){echo "test"}```"""
Package: mdformat-black
mdformat-blackMdformat plugin to Blacken Python code blocksDescriptionmdformat-black is anmdformatplugin
that makes mdformat format Python code blocks withBlack.UsageInstall with:pipinstallmdformat-blackWhen using mdformat on the command line, Black formatting will be automatically enabled after install.When using mdformat Python API, code formatting for Python will have to be enabled explicitly:importmdformatunformatted="```python\n'''black converts quotes'''\n```\n"formatted=mdformat.text(unformatted,codeformatters={"python"})assertformatted=='```python\n"""black converts quotes"""\n```\n'
Package: mdformat_deflist
mdformat-deflistAnmdformatplugin formarkdown-it-deflist.DevelopmentThis package utilisesflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstalltoxTo run the tests:toxand with test coverage:tox-epy37-covThe easiest way to write tests, is to edit tests/fixtures.mdTo run the code formatting and style checks:tox-epy37-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy37-hookPublish to PyPiEither use flit directly:pipinstallflit
flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat_footnote
mdformat-footnoteFootnote format addition formdformat.DevelopmentThis package utilisesflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstalltoxTo run the tests:toxand with test coverage:tox-epy39-covThe easiest way to write tests, is to edit tests/fixtures.mdTo run the code formatting and style checks:tox-epy39-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy39-hookPublish to PyPiEither use flit directly:pipinstallflit
flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat_frontmatter
mdformat-frontmatterAnmdformatplugin for ensuring that yamlfront-matteris respected.
Many tools (such asjekyll) use yaml front matter for automation purposes.mdformat-frontmatteronly supports yaml. For example:---test: yaml---# This looks okayFor some markdown code.Frontmatter can only be at the first line or two of the code.# This is not---test: yaml---Note: that at this stage this plugin is not that sophisticated. The principle objective is to allow properly formed yaml header blocks to pass through.
Incorrectly formed blocks may result in strange behaviour.DevelopmentThis package was built from thetemplateprovided byexecutable booksand customized (specifically to separate content PR's from the release cycle).
This package driverflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstalltoxTo run the tests:toxand with test coverage:tox-epy37-covThe easiest way to write tests, is to edit tests/fixtures.mdTo run the code formatting and style checks:tox-epy37-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy37-hookPublish to PyPiEither use flit directly:pipinstallflit
flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat-gfm
mdformat-gfmMdformat plugin for GitHub Flavored Markdown compatibilityDescriptionMdformatis a formatter forCommonMarkcompliant Markdown.Mdformat-gfm is an mdformat plugin that changes the target specification toGitHub Flavored Markdown (GFM),
making the tool able to format the following syntax extensions:tablestask list itemsstrikethroughsautolinksdisallowed raw HTML(note that no changes are required from a formatter to support this extension)Installpipinstallmdformat-gfmUsagemdformat<filename>
Package: mdformat-gofmt
mdformat-gofmtMdformat plugin to gofmt Go code blocksDescriptionmdformat-gofmt is anmdformatplugin
that makes mdformat format Go code blocks withgofmt.
The plugin invokes gofmt in a subprocess so having Go installed is a requirement.InstallingInstall GoInstall mdformat-gofmtpipinstallmdformat-gofmtUsagemdformatYOUR_MARKDOWN_FILE.md
Package: md-format-hook
md-formatA pre-commit hook that formats .md files. It automatically adds reasonable spaces between Chinese and English and corrects the case of special nouns.For pre-commit: seehttps://github.com/pre-commit/pre-commitUsing md-format with pre-commitAdd this to your.pre-commit-config.yaml:-repo:https://github.com/PKUcoldkeyboard/md-formatrev:0.0.5hooks:-id:md-format
Package: mdformat_mkdocs
mdformat-mkdocsAnmdformatplugin formkdocsandmkdocs-materialin particular.Supports:Indents are converted to 4-spaces instead of 2Note: see caveats when using the optional Semantic Indents on numbered lists which may not be a full multiple of 4List bullets are converted to dashes instead of*Admonitions (extendsmdformat-admon)MKDocs-Material Content Tabs (https://squidfunk.github.io/mkdocs-material/reference/content-tabs)Note: the markup (HTML) rendered by this plugin is sufficient for formatting but not for viewing in a browser. Please open an issue if you have a need to generate valid HTML.See the example test files,./tests/pre-commit-test.mdand./tests/format/fixtures.mdmdformatUsageAdd this package wherever you usemdformatand the plugin will be auto-recognized. No additional configuration necessary. For additional information on plugins, seethe officialmdformatdocumentation hereTip: this package specifies an "extra" ('recommended') for plugins that work well withmkdocs:mdformat-beautyshmdformat-blackmdformat-configmdformat-footnotemdformat-frontmattermdformat-simple-breaksmdformat-tablesmdformat-tocmdformat-webPre-Commitrepos:-repo:https://github.com/executablebooks/mdformatrev:0.7.16hooks:-id:mdformatadditional_dependencies:-mdformat-mkdocs>=2.0.0# Or# - "mdformat-mkdocs[recommended]>=2.0.0"pipxpipxinstallmdformat
pipxinjectmdformatmdformat-mkdocs# Or# pipx inject mdformat "mdformat-mkdocs[recommended]"HTML RenderingTo generate HTML output,mkdocs_admon_plugincan be imported frommdit_plugins. More plugins will be added in the future. For more guidance onMarkdownIt, see the docs:https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parserfrommarkdown_itimportMarkdownItfrommdformat_mkdocs.mdit_pluginsimportmkdocs_admon_pluginmd=MarkdownIt()md.use(mkdocs_admon_plugin)text='??? note\ncontent'md.render(text)# <details class="note"># <summary>Note</summary># <p>content</p># </details>CLI Optionsmdformat-mkdocsadds the CLI argument--align-semantic-breaks-in-liststo optionally align line breaks in numbered lists to 3-spaces. If not specified, the default of 4-indents is followed universally.# with: mdformat
1. Semantic line feed where the following line is
    three spaces deep

# vs. with: mdformat --align-semantic-breaks-in-lists
1. Semantic line feed where the following line is
   three spaces deepNote: thealign-semantic-breaks-in-listssetting is not supported in the configuration file yet (https://github.com/executablebooks/mdformat/issues/378)ContributingSeeCONTRIBUTING.md
Package: mdformat_myst
mdformat-mystMdformat plugin for MyST compatibilityDescriptionMdformatis a formatter forCommonMarkcompliant Markdown.Mdformat-myst is an mdformat plugin that changes the target specification toMyST,
making the tool able to format the following syntax extensions:tablesdirectivesrolesinline and block "dollar math"commentsblock breakstargetsfront matterfootnotesInstallpipinstallmdformat-mystUsagemdformat<filename>
Package: mdformat-openmmlab
mdformat-openmmlabAnmdformatplugin for OpenMMLab standard.How to use itAdd the follow section to.pre-commit-config.yaml:-repo:https://github.com/executablebooks/mdformat# To be compatible with Python 3.6, specify the version here.rev:0.7.9hooks:-id:mdformatargs:["--number","--table-width","200"]additional_dependencies:-mdformat-openmmlab-mdformat_frontmatter-linkify-it-pyThe argument--table-widthis used to limit the max width of tables.If you want to avoid escaping some symbols, you can use--disable-escapeand specify the symbols to skip.For example, to avoid escaping backslash (\) and uri-enclosure (<).-repo:https://github.com/executablebooks/mdformat# To be compatible with Python 3.6, specify the version here.rev:0.7.9hooks:-id:mdformatargs:["--number","--table-width","200","--disable-escape","backslash","--disable-escape","uri-enclosure"]additional_dependencies:-"mdformat-openmmlab>=0.0.4"-mdformat_frontmatter-linkify-it-pyHere are available options:backslash(\)asterisk(*)underscore(_)link-enclosure([and])uri-enclosure(<)ATTENTION: This plugin already include all functionalities ofmdformat-gfmandmdformat-tables, and is
not compatible with them, please don't install them again.DevelopmentThis package utilisesflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstalltoxTo run the tests:toxand with test coverage:tox-epy37-covThe easiest way to write tests, is to edit tests/fixtures.mdTo run the code formatting and style checks:tox-epy37-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy37-hookPublish to PyPiEither use flit directly:pipinstallflit
flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat_pelican
mdformat-pluginAnmdformatplugin for the pelican static site generator.Pelicanis a static site generator and uses markdown with a couple of additions,
namely skipping the K:V pairs at the start and the ability to reference:tagauthorcategoryindexfilenamestaticattachNote that the{name}forms are supported, and the|name|forms are converted to the newer form,
as the pipe form has been deprecated.DevelopmentThis package utilisesflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstalltoxTo run the tests:toxand with test coverage:tox-epy37-covThe easiest way to write tests, is to edit tests/fixtures.mdTo run the code formatting and style checks:tox-epy37-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy37-hookPublish to PyPiEither use flit directly:pipinstallflit
flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat_pyproject
mdformat-pyprojectAnmdformatplugin to read configuration frompyproject.toml.InstallInstall with:pipinstallmdformat-pyprojectUsageAfter installing this plugin, themdformat configurationcan be added in
a new[tool.mdformat]section inside thepyproject.tomlfile.[tool.mdformat]wrap="keep"# possible values: {"keep", "no", INTEGER}number=false# possible values: {false, true}end_of_line="lf"# possible values: {"lf", "crlf", "keep"}Usage as apre-commithookAdd the following to your.pre-commit-config.yaml:-repo:https://github.com/executablebooks/mdformatrev:0.7.13# Use the ref you want to point athooks:-id:mdformatadditional_dependencies:-mdformat-pyproject
Package: mdformat-ruff
mdformat-ruffMdformat plugin to ruffen Python code blocksDescriptionmdformat-ruff is anmdformatplugin
that makes mdformat format Python code blocks withruff.UsageInstall with:pipinstallmdformat-ruffYou may pin ruff dependency for formatting stability:pipinstallmdformat-ruffruff==22.1.0When using mdformat on the command line, ruff formatting will be automatically
enabled after install.When using mdformat Python API, code formatting for Python will have to be
enabled explicitly:importmdformatunformatted="```python\n'''ruff converts quotes'''\n```\n"formatted=mdformat.text(unformatted,codeformatters={"python"})assertformatted=='```python\n"""ruff converts quotes"""\n```\n'Usage as apre-commithookAdd the following to your.pre-commit-config.yaml:-repo:https://github.com/executablebooks/mdformatrev:0.7.13# Use the ref you want to point athooks:-id:mdformatadditional_dependencies:-mdformat-ruff-ruff==22.1.0# Pinning ruff here is optional
Package: mdformat-rustfmt
mdformat-rustfmtMdformat plugin to rustfmt Rust code blocksDescriptionmdformat-rustfmt is anmdformatplugin
that makes mdformat format Rust code blocks withrustfmt.
The plugin invokes rustfmt in a subprocess so having it installed is a requirement.InstallingInstall rustfmtInstall mdformat-rustfmtpipinstallmdformat-rustfmtUsagemdformatYOUR_MARKDOWN_FILE.md
Package: mdformat-sentencebreak
mdformat-sentencebreakAnmdformatplugin that adds line wrapping based on sentence completion marks.BehaviorThis input ....> Long sentences are broken at punctuation marks,
> unless the generated sentence would be extremely small
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.

> And it will not break sentences if
> they are inside something else ... emphasis for example
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.

> Sentences are kept separate if they end in punctuation

Some.
Very.
Small.
Series.
of.
Sentences.

> Sentences are combined if they do not end in punctuation.

a
very
sloppy
sentenceWill get this ....Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.

**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**

Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.

Some.
Very.
Small.
Series.
of.
Sentences.

a very sloppy sentenceInstallationpip install mdformat-sentencebreakOr using pipxpipx install mdformat
pipx inject mdformat mdformat-sentencebreakUsageAfter installing mdformat and mdformat-sentencebreak,
you can format a markdown file by calling:mdformat{NAME_OF_YOUR_MARKRDOWN_FILE.md}TODO:Support for ellipsis in a long line(...) gets broken into . ..
Package: mdformat-shfmt
mdformat-shfmtMdformat plugin to format shell code blocksDescriptionmdformat-shfmt is anmdformatplugin
that makes mdformat format shell code blocks embedded in Markdown withshfmt.
The plugin invokes shfmt in a subprocess so having either shfmt or Docker installed is a requirement.InstallingInstall eithershfmtorDockerInstall mdformat-shfmtpipinstallmdformat-shfmtUsagemdformatYOUR_MARKDOWN_FILE.mdLimitationsFormatting with Docker is not tested on Windows.
If you experience issues on Windows, install shfmt.
Package: mdformat_simple_breaks
mdformat-simple-breaksAnmdformatplugin to render thematic breaks
using three dashes instead of 70 underscores.InstallInstall with:pipinstallmdformat-simple-breaksUsage as apre-commithookAdd the following to your.pre-commit-config.yaml:-repo:https://github.com/executablebooks/mdformatrev:0.7.13# Use the ref you want to point athooks:-id:mdformatadditional_dependencies:-mdformat-simple-breaksPlugin rationaleTheCommonMark specificationstates that thematic breaks, which are to be
rendered as horizontal rules<hr>, should be coded as:A line consisting of optionally up to three spaces of indentation, followed by a sequence of
three or more matching-,_, or*characters, each followed optionally by any number of
spaces or tabsAs a result, most of the Markdown guides and cheat sheets show a line made of three dash symbols
as an example of a thematic break:---On the other hand,mdformatrenders these thematics breaks by default as a line of 70
consecutive underscore characters:________________________________________________________________________________This is anexplicit style decisionthat is not going to be reverted and for which
no configuration will be added.As a result, this plugin has been created to override that decision and go back to the three-thematic breaks.
Package: mdformat_tables
mdformat-tablesAnmdformatplugin for rendering tables.For example, converting:a | b | c
:- | -: | :-:
1 | 2 | 3
xxxxxx | yyyyyy | zzzzzzto:| a      |      b |   c    |
| :----- | -----: | :----: |
| 1      |      2 |   3    |
| xxxxxx | yyyyyy | zzzzzz |For further examples, see tests/fixtures.md in the repository.DevelopmentThis package utilisesflitas the build engine, andtoxfor test automation.To install these development dependencies:pipinstallflittoxTo run the tests:toxTo run the code formatting and style checks:tox-epy37-pre-commitor directlypipinstallpre-commit
pre-commitrun--allTo run the pre-commit hook test:tox-epy37-hookPublish to PyPiEither use flit directly:flitpublishor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g.v0.0.1.Note, this requires generating an API key on PyPi and adding it to the repositorySettings/Secrets, under the namePYPI_KEY.
Package: mdformat-toc
mdformat-tocMdformat plugin to generate a table of contentsTable of Contentsgenerated withmdformat-tocDescriptionInstallUsageConfigurationMinimum and maximum heading levelsDisabling anchor generationChanging the slug functionDescriptionMdformat-toc is anmdformatplugin
that adds mdformat the capability to auto-generate a table of contents (ToC).
The ToC is generated in a user-specified location in the Markdown file.Mdformat-toc, by default, creates an HTML anchor for each heading listed in the ToC.
ToC links should therefore be compatible with any well-behaved Markdown renderer (including GitLab's renderer).HTML anchor generation can be disabled, in which case a user should configure a slug function that is compatible with the Markdown renderer used (GitHub and GitLab slug functions are currently supported).Installpipinstallmdformat-tocUsageAdd the following line to your Markdown file.
A ToC will be generated in the location indicated by it.<!-- mdformat-toc start -->After adding the indicator line, simply runmdformat<filename>and mdformat will generate a ToC.ConfigurationArguments can be added to the indicator line to alter how the ToC is generated.
An indicator line with the default options would look like:<!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=1 -->Placing more than one indicator lines in a document is currently not supported.Minimum and maximum heading levelsA user can configure a range of heading levels to be included in the ToC (and to be "anchored").
For instance, the following configuration will only list 2nd, 3rd and 4th level headings in the ToC:<!-- mdformat-toc start --minlevel=2 --maxlevel=4 -->Disabling anchor generationBy default, an HTML anchor is appended to each heading.
For instance, the following heading# Some titlemight be formatted as# Some title<a name="some-title"></a>This ensures that ToC links do not rely on a Markdown renderer to create HTML anchors,
and makes the links universally compatible.ToC links are by default compatible with the anchors generated by GitHub's Markdown renderer.
If your Markdown is only hosted on GitHub, you can disable mdformat-toc's HTML anchor generation:<!-- mdformat-toc start --no-anchors -->Changing the slug functionMdformat-toc defaults to using GitHub's slug function.If your Markdown is not hosted on GitHub you may want to use GitLab's slug function instead:<!-- mdformat-toc start --slug=gitlab --no-anchors -->NOTE:Unlike GitLab, GitHub requires using its own slug function in order for ToC links to work expectedly.
Creating HTML anchors and using a non-GitHub slug function is not GitHub compatible
because GitHub's Markdown renderer modifies the HTML anchors mdformat-toc creates.
The default configuration
(GitHub slug function and anchor generation)
is the only configuration cross-compatible with GitHub and GitLab.
Package: mdformat-wikilink
mdformat-wikilinkAnmdformatplugin for ensuring that wiki-style links ([[Target|Alias]])
are preserved during formatting.Source:This is a [[link]].With the plugin:This is a [[link]].Without the plugin:This is a \[\[link\]\].InstallationAfter installing mdformat,# With pippipinstallmdformat-wikilink# With pipxpipxinjectmdformatmdformat-wikilink