Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-caption
MkDocs CaptionPackageMetaCIEnhance yourMkDocsdocumentation with easy figure, table captioning and numbering.FeaturesTable and Figure captioning and numberingAutomatic link text generation for referencesHighly configurableExtensible to support captions for all Element typesDocumentationFor full documentation, visithttps://tobiasah.github.io/mkdocs-caption/.Installationpip install mkdocs-captionQuick UsageInmkdocs.yml:...
plugins:
- captionInside the Markdown, the following will now be converted into a figure/table with
caption and numbering.![figure caption](img.jpg)

Table: table caption

| heading 1| heading 2 | 
| - | - | 
| content 1 | content 2 |
| content 3 | content 4 |<p>
  <figure id=_figure-1>
    <img src="img.jpg" />
    <figcaption>Figure 1. figure caption</figcaption>
  </figure>
</p>
<p>
<table id="_table_1">
  <thead>
    <tr>
      <th>heading 1</th>
      <th>heading 2</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>content 1</td>
      <td>content 2</td>
    </tr>
    <tr>
      <td>content 3</td>
      <td>content 4</td>
    </tr>
  </tbody>
  <caption>Table 1: table caption</caption>
</table>Licensemkdocs-captionis distributed under the terms of theMITlicense.
Package: mkdocs-caseinsensitive-plugin
mkdocs-caseinsensitive-pluginThis plugin allows you to link to case-insensitive documentation files.UsecaseWhen presented with the following tree directory structure:project
│   works_for_images.md (contains link to "folder1/IMAGE.PNG")
│   works_for_markdown.md (contains link to "FOLDER1/readme.md")
│
└───folder1
│   │   image.png
│   │   README.mdMkDocs will produce the following logging warning messagesWARNING  -  Documentation file 'works_for_images.md' contains a link to 'folder1/IMAGE.PNG' which is not found in the documentation files.
WARNING  -  Documentation file 'works_for_markdown.md' contains a link to 'FOLDER1/readme.md' which is not found in the documentation files.Consequently, the rendered HTML files will not have the appropriate links in place.This issue has been raised on theMkDocs repositorybeforehere. Understandably, this is desirable behaviour due to the differences in operating systems in how lax they are when it comes to case-sensitivity in files and directories.InstallationInstall the package with pip:pipinstallmkdocs-caseinsensitive-pluginTODO:
Install the package from source with pip:gitclonehttps://github.com/TheMythologist/mkdocs-caseinsensitive-plugin.gitEnable the plugin in yourmkdocs.yml:plugins:
    - search: {}
    - caseinsensitive: {}NOTE:If you have nopluginsentry in your configuration file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.
Package: mkdocs-changelog-plugin
mkdocs-changelog-plugin一个用于在 mkdocs 文档中插入 changelog 时间轴的插件。预览：https://note.tonycrane.cc/changelog/安装可以通过 pypi 直接安装：$pipinstallmkdocs-changelog-plugin也可以从源码安装$gitclonehttps://github.com/TonyCrane/mkdocs-changelog-plugin.git
$cdmkdocs-changelog-plugin
$pipinstall.# or pip install -e .使用在 mkdocs.yml 中启用插件：plugins:-changelogchangelog 从外部的 yaml 文件读取，默认在 docs/changelog.yml 中，可以通过 file 选项来选择其他位置：plugins:-changelog:file:changelog.yml按照格式编写 changelog yaml 文件（见下）在需要插入 changelog 的页面 meta 部分中添加：changelog:True在页面需要插入对应部分的位置添加：{{ placeholder }}changelog.yml 格式例如：-"placeholder1":-"time1":-"type":text-"type":text-"placeholder":-"time2":-"type":text:texthref:/link/to/page/-"type":text:texthref:/link/to/page/-"time3":-"type":textplaceholder 是在 md 文件插入位置写入 {{ }} 的内容time 是时间标题type 是更改类型插件内自带三种：newpage：新建页面pageupdate：页面更新function：功能性更新可以自定义插入 custom css 即可，例如自定义 refactor type：.changelog-type-refactor{background-color:#c63f94b0;}.changelog-type-refactor::before{content:"文档重构";}如果没有对应 css，则显示为蓝色的“更新”type 后可以直接写文本，会直接写在更新类型后面（不支持 markdown，但可以 html）type 后也可以按如上写 text 和 href，此时会给 text 加上 href 指定的 link（利用 a 元素）具体可以参考我的 changelog.yml。主题适配感觉 mkdocs 主流主题只有 material 用得多了，所以没做其他主题的适配。基本上就差在几个颜色的问题上，问题不大，可以自己通过 css 来覆盖这里规定的颜色，具体看 css/timeline.css。开发嘛，基本就是我用纯 html+css 糊出来自己用的，然后为了方便写了个插件，代码也比较乱，在别人的主题里面可能会格式混乱、颜色爆炸。有想修改、改进的我非常且热烈欢迎，尽管 PR 就好（参考timvink/mkdocs-git-revision-date-localized-pluginunverbuggt/mkdocs-encryptcontent-plugin
Package: mkdocs-charts-plugin
mkdocs-charts-pluginMkDocsplugin to create plots from data using the declarativevegalitesyntax. This makes it easier tobuild reproducible reports with MkDocs.👉 See it in action on thedemo pageIncludes supports formkdocs-materialtheme features likeinstant loadinganddark color themes.Do checkout the othercharting plugins for mkdocsthat might suit your specific use-case better.InstallationInstall the plugin usingpip3:pip3installmkdocs-charts-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - charts

extra_javascript:
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: vegalite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegaliteIf you have nopluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.UsageYou can insert any validvegaliteJSON into a markdown file using:```vegalite
{
  "$schema": "https://vega.github.io/schema/vega-lite/v5.json",
  "description": "A simple bar chart with embedded data.",
  "data": {
    "values": [
      {"a": "A", "b": 28}, {"a": "B", "b": 55}, {"a": "C", "b": 43},
      {"a": "D", "b": 91}, {"a": "E", "b": 81}, {"a": "F", "b": 53},
      {"a": "G", "b": 19}, {"a": "H", "b": 87}, {"a": "I", "b": 52}
    ]
  },
  "mark": "bar",
  "encoding": {
    "x": {"field": "a", "type": "nominal", "axis": {"labelAngle": 0}},
    "y": {"field": "b", "type": "quantitative"}
  }
}
```See thevegalite editorfor a range of examples you could copy-paste into your mkdocs siteDocumentationSee the documentationtimvink.github.io/mkdocs-charts-pluginfor examples, use cases and options.
Package: mkdocs-childpages-card-grid-plugin
MkDocs Child Pages Card Grid PluginUnder development, use with caution!This plugin allows users to automatically add card grids on their pages with links to child pages.Users can include card grids on all pages or configure using Markdown metadata to include or exclude specific pages.TODO items:Add linters, build, versioning, tests, etc. Professional stuff 😄Add config to always include or exclude a page in their parent card grid.Add support to includeteasercontent from metadata, possibly in conjunction with thewilhelmer/mkdocs-add-teaser plugin.Configtheme:name:materialfeatures:-navigation.indexesextra_css:-stylesheets/childpages_card_grid.cssplugins:-childpages-card-grid:# include card grids on all pages (default True)include_all:True# the title shown above the card grid (default: 'Child pages')cards_title:'Childpages'Page Metadatachildpages_card_gridWheninclude_all: True, it possible to exclude the card grid from a page with the metadata:childpages_card_grid: exclude.Likewise, wheninclude_all: False, it is possible to include the card grid in a page usingchildpages_card_grid: include.childpages_card_grid_titleIt is possible to customize the card grid title of a specific page with thechildpages_card_grid_titlemetadata.Sample childpages_card_grid.css.cards{max-width:1200px;margin:0auto;display:grid;gap:1rem;grid-template-columns:repeat(auto-fit,minmax(300px,1fr));}.card{/* Add shadows to create the "card" effect */box-shadow:04px8px0rgba(0,0,0,0.2);transition:0.3s;}.card_title{padding:1rem01rem0;border-top:1px;border-top-color:gray;border-top-style:solid;}.card:hover{/* On mouse-over, add a deeper shadow */box-shadow:08px16px0rgba(0,0,0,0.2);}.card_container{/* Add some padding inside the card container */padding:2px16px;}LimitationsThis plugin was only tested with MkDocs Material Theme and thenavigation.indexesfeature enabled. It may be that other themes or other features of the Material theme generate a differentnavtree and this plugin will not be able to figure out the parent/child pages.
Package: mkdocs-codeinclude-plugin
mkdocs-codeinclude-pluginA plugin for mkdocs that allows some advanced 'includes' functionality to be used for embedded code blocks.
This is effectively an extended Markdown format, but is intended to degrade gracefully when rendered with a different renderer.InstallationInstall the plugin:pip install mkdocs-codeinclude-pluginAddcodeincludeto the list of your MkDocs plugins (typically listed inmkdocs.yml):plugins:-codeincludeThe plugin should be configured use an appropriate form of tabbed fences, depending on the version ofpymdown-extensionsthat is installed.
Tabbed fences provide a 'title' for code blocks, and adjacent code blocks will appear as a multi-tabbed code block.a. For version 8.x ofpymdown-extensions, use the following or leave blank (default):plugins:-codeinclude:title_mode:pymdownx.tabbedb. For version 7.x or lower ofpymdown-extensions, use the following:plugins:-codeinclude:title_mode:legacy_pymdownx.superfencesc. If no tabbed fences should be used at all:plugins:-codeinclude:title_mode:noneUsageA codeinclude block resembles a regular markdown link surrounded by a pair of XML comments, e.g.:<!--codeinclude-->
[Human readable title for snippet](./relative_path_to_example_code.java) targeting_expression
<!--/codeinclude-->Wheretargeting_expressioncould be:block:someStringorinside_block:someStringIf these are provided, the macro will seek out any line containing the tokensomeStringand grab the next curly brace
delimited block that it finds.blockwill grab the starting line and closing brace, whereasinside_blockwill omit
these. If notargeting_expressionis provided, the whole file is included.e.g., given:publicclassFooService{publicvoiddoFoo(){foo.doSomething();}}If we useblock:doFooas our targeting expression, we will have the following content included into our page:publicvoiddoFoo(){foo.doSomething();}Whereas usinginside_block:doFoowe would just have the inner content of the method included:foo.doSomething();Note that:Any code included will be have its indentation reducedEvery line in the source file will be searched for an instance of the token (e.g.doFoo). If more than one line
includes that token, then potentially more than one block could be targeted for inclusion. It is advisable to use a
specific, unique token to avoid unexpected behaviour.When we wish to include a section of code that does not naturally appear within braces, we can simply insert our token,
with matching braces, in a comment.
While a little ugly, this has the benefit of working in any context, even in languages that do not use
curly braces, and is easy to understand.
For example:publicclassFooService{publicvoidboringMethod(){doSomethingBoring();// doFoo {doTheThingThatWeActuallyWantToShow();// }}}will be rendered as:doTheThingThatWeActuallyWantToShow();Building the ProjectInstall the dependencies:pipinstall-rrequirements.txt
pipinstallpytest# install pytest to run the testsRunning testsTo run the tests:pytestFormatting codeCode is formatted with Black. To apply formatting:blackcodeincludetests
Package: mkdocs-code-runner
mkdocs-code-runnermkdocs-code-runner is anMkDocsplugin which converts Javascript code
blocks in Markdown files into runnable scripts for your browser.Getting StartedInstallationmkdocs-code-runner can be installed for Python 3.6+ withpipinstall--usermkdocs-code-runnerContributingFor guidance on setting up a development environment and making a contribution to mkdocs-code-runner,
see thecontributing guide.LicenseDistributed under the terms of theMIT license, mkdocs-code-runner is
free and open source software.
Package: mkdocs-code-validator
mkdocs-code-validatorChecks Markdown code blocks in aMkDocssite against user-defined actionspipinstallmkdocs-code-validatorUsageActivate the plugin inmkdocs.yml. Theidentifiersconfig is mandatory. And the plugindoesn't work withoutpymdownx.superfences:plugins:-search-code-validator:identifiers:bash:validators:-grep amarkdown_extensions:-pymdownx.superfencesThe above contrived config checks that every```bashcode block in the Markdown files of this MkDocs site must contain the letter "a", otherwise a warning will appear.The content of each code block is piped as stdin to the command. The exit code of the command is what's checked: a non-zero code will produce a warning (which in MkDocs you can make fatal with the--strictflag). The output of the command is not used in any way, only preserved on the screen as part of a warning.You can add any number of identifiers, and within them any number ofvalidatorscommands, each of them has the ability to produce a warning.If stdin is not usable with your command, the input can be passed as a temporary file instead -- that is done if the command contains the exact argument$<(which is then replaced with a file path). For the above example, changing the command togrep a $<would be equivalent (other than technicalities).The commands donotallow freeform shell syntax, it's just one subprocess to call with its arguments. To explicitly opt into a shell, just run it as (e.g.)sh -c 'if grep a; then exit 1; fi'. Or, with a temporary file:sh -c 'if grep a "$1"; then exit 1; fi' $<.The definition of what a code block is is all according to thepymdownx.superfencesextension. It must be enabled; the plugin won't do anything without it.
Package: mkdocs-codeyaml-plugin
# mkdocs-codeyml-pluginA MkDocs plugin that injects the mkdocs.yml extra variables PLUS extra YML files into the markdown templatebased on the great [mkdocs-markdownextradata-plugin](https://pypi.org/project/mkdocs-markdownextradata-plugin/)usecase` We wanted language specific yml files to hold necessary code snippets `
Package: mkdocs-conditional-include
File exclude plugin for mkdocsmkdocs-excludeis amkdocs pluginthat allows you
to conditionally include files from your input using regular expressions (regexes).This will only include the following files in yourmkdocs:file location does not have the specified prefixfile is in the specified prefix, and matches any of the specified regexesThe big advantage of this is, that you can include your closed-source repositories into amkdocs monorepo, and explicitly ONLY include your documentation sub-folders in themkdocsartifacts.Quick startInstall the module using pip:pip3 install mkdocs-conditional-includeIn your project, add a plugin configuration tomkdocs.yml:plugins:-conditional_include:rules:-prefix:my-docsregex:-'.*\/docs\/.*'-'.*\/docs-assets\/.*'-prefix:my-docs-2regex:-'.*\/docs\/.*'Not specifying any prefix will run the particular rule over all files, thus filtering everything.
Package: mkdocs-conia
MkDocs Conia ThemeThis is a theme for MkDocs which is mainly used inConiaprojectsInstallationInstall the package from PyPi usingpip:pip install mkdocs-coniaAdd the theme to yourmkdocs.ymlfile:theme:
    name: coniaDevelopment servermkdocs serve -w themeStylesInstall Dart Sass vianpm install -g sass. During develompment:sass --watch styles:themeDeploy to PyPiInstalltwineif not already done. Bump version number insetup.py, then:git tag -a vX.X.X -m "Version X.X.X"
git push origin vX.X.X
sass --style=compressed --no-source-map styles:theme
python setup.py bdist_wheel
twine upload dist/*
Package: mkdocs-copy
Copy files in your MkDocs buildmkdocs-copy is a plugin forMkDocswhich allows you to copyverbatimarbitrary files in your build.Why?This plugin was created to solvehttps://github.com/mkdocs/mkdocs/issues/2139(at least some use-cases affected by it). Basically it's a work-around for the following (willingly) hard-coded chunk in MkDocs' sources:# mkdocs/structure/files.py used bydefget_files(config):""" Walk the `docs_dir` and return a Files collection. """files=[]exclude=['.*','/templates']# ...Note: one could achieve the same result using something likemkdocs-gen-filesormkdcos-simple-hooks, only with some more effort. The benefit of using mkdocs-copy dedicated plugin lies in its declarative API. It is also easily reusable.Quick startSay you want to add .htaccess files (if defined for a given folder/path):# mkdocs.yml config fileplugins:-mkdocs-copy:add_per_path:-.htaccess
Package: mkdocs-cordova-plugin
# Mkdocs Cordova PluginPublish documentation to any mobile device via [Apache Cordova][cordova].—[![MIT License][license-badge]][license]
[![Gitlab pipeline status][gitlab-ci-badge]][gitlab-ci]
[![PyPI][pypi-badge]][pypi]## DocumentationSee [docs](docs/index.md) for more information.## ResourcesMkdocsView the [MkDocs documentation][mkdocs].Visit the [MkDocs wiki](https://github.com/mkdocs/mkdocs/wiki) for community
resources, including third party themes and a list of MkDocs users.IRC channel:#mkdocson freenode.Discussions and support: <https://groups.google.com/forum/#!forum/mkdocs>Apache CordovaView the [Apache Cordova documentation][cordova-docs].Joincordovaon [Slack][cordova-slack]!Join the [mailing list][cordova-mailing-list].Discussions and support: <https://stackoverflow.com/questions/tagged/cordova>### Code of ConductEveryone interacting in the MkDocs project’s codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the [PyPA Code of Conduct].[cordova]:https://cordova.apache.org[cordova-docs]:https://cordova.apache.org/docs[cordova-slack]:https://slack-cordova-io.herokuapp.com[cordova-mailing-list]:https://cordova.apache.org/contact[license]:https://mit-license.org[license-badge]:https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square[mkdocs]:https://www.mkdocs.org[gitlab-ci]:https://gitlab.com/lramage/mkdocs-cordova-plugin/pipelines[gitlab-ci-badge]:https://img.shields.io/gitlab/pipeline/lramage/mkdocs-cordova-plugin.svg?style=flat-square[PyPA Code of Conduct]:https://www.pypa.io/en/latest/code-of-conduct[pypi]:https://pypi.python.org/pypi/mkdocs-cordova-plugin[pypi-badge]:https://img.shields.io/pypi/v/mkdocs-cordova-plugin.svg?style=flat-square
Package: mkdocs-coverage
MkDocs Coverage PluginMkDocs plugin to integrate your coverage HTML report into your site.InstallationWithpip:pipinstallmkdocs-coverageWithpipx:python3.8-mpipinstall--userpipx
pipxinstallmkdocs-coverageUsage# mkdocs.ymlnav:-Coverage report:coverage.mdplugins:-coverage:page_name:coverage# defaulthtml_report_dir:htmlcov# defaultNow serve your documentation,
and go tohttp://localhost:8000/coverage/to see your coverage report!
Package: mkdocs-custom-fences
MKDOCS CUSTOM FENCESThis package is for mkdocs and include some "code snippet" to create custom fences usingpydownx superfences. This allow to customize your code blocks during the processor of your mkdocs.For the moment, it includes onlymd_render.Get startedpip install mkdocs_custom_fencesAfter the installation you should be able to access the extensions inmkdocs.ymlusingmkdocs_custom_fences.file.class. See below for more information using configuration.Mkdocs configurationIn yourmkdocs.ymlconfiguration you need to configure superfences to use custom fences.markdow_extensions:pymdownx.superfences:custom_fences:-name:languageclass:languageformat:!!python/name:mkdocs_custom_fences.file.classMarkdown Render→ Configuration :!!python/name:mkdocs_custom_fences.md_render.md_sub_renderThis custom formattor allow you to "force" markdown and remove the code block.Add this in your configuration :markdow_extensions:pymdownx.superfences:custom_fences:-name:md-renderclass:md-renderformat:!!python/name:mkdocs_custom_fences.md_render.md_sub_render💡You can customize the name and class with any language you want.Example :```md-render
    |Col0|Col1|Col2|Col3|
    |----|----|----|----|
    |xml |x|x|x|
    ```Will become :ContributionI will be happy to see any new configuration and custom fences.To contribute :Fork and clone this projectpip install -r requirements.txt(I advice you to use virtual environment ; personnaly I use conda.)Create a new file (don't use any already custom fences for new customization). Don't forget to update the requirements.txt if you need).Edit this README to add an example and the configuration.Add the custom fences tothe list.Create a pull request⚠️ You need to useconventionnal commitas described here
Package: mkdocs-custommill
CustomMill theme forMkDocsAnother iteration on the awesomeWindmill themefor MkDocs. This is permitted by the MIT License.Highlights:Clean navigation for large documentation projectsRetains the state of the menu across page transitionsVersatile search with term highlighting in a quick search and on its own pageSupports syntax highlighting within pagesDeep nesting of pages in foldersImprovements over WindmillCustomizable colors!Customizable links in the navigation menuA lot of small stylistic and design fixesBetter search result listingBootstrap 5 and no more jQueryQuick startTo install usingpip:pipinstallmkdocs-custommillTo use inmkdocs.yml:theme:custommillDemo and documentationSeeherefor a demo and some documentation :)DevelopmentIf doing development onmkdocs-custommill, check it out withgitclonehttps://github.com/Siphalor/mkdocs-custommill/cdmkdocs-custommill
Package: mkdocs-d2-plugin
mkdocs-d2-pluginA plugin for embedding D2 diagrams in MkDocs.Documentation and live demo can be foundhere.RequirementsMkDocs>= 1.5.0D2>= 0.6.3InstallationInstall the plugin using pip:pipinstallmkdocs-d2-pluginAnd add it to yourmkdocs.yml:plugins:-d2UsageFenced code block```d2shape: sequence_diagramAlice -> John: Hello John, how are you?Alice -> John.ack: John, can you hear me?John.ack -> Alice: Hi Alice, I can hear you!John -> Alice: I feel great!```Image tag![Diagram](diagram.d2)Demo appYou can find demo app in thedocsdirectory.
Live version is availablehere.To run in locally:cddocs
python3-mvenv.venvsource.venv/bin/activate
pipinstallmkdocs-materialmkdocs-d2-plugin
mkdocsserveTo run it using Docker:cddocs
dockerbuild--tagmkdocs-d2-plugin:latest.
dockerrun--rm-it-p8000:8000-v${PWD}:/docsmkdocs-d2-plugin:latest
Package: mkdocs-deploy
mkdocs-deployThis README is a little about the project and how to contribute.SeeProduct documentationfor instructions on how to use it.Aboutmkdocs-deploy began as a drop-in replacement formike.  The main goal is to provide
a deployment tool that is version aware and plugable, capable of deploying multiple versions side by side to any target
website.AuthorMkdocs-deploy was developed by Philip Couling while working atHabitat Energy.