Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-git-revision-date-localized-plugin
mkdocs-git-revision-date-localized-pluginMkDocsplugin that enables displaying the date of the last git modification of a page. The plugin usesbabelandtimeago.jsto provide different localized date formats. Initial fork frommkdocs-git-revision-date-plugin.(Example when used together with themkdocs-materialtheme)Other MkDocs plugins that use information from git:mkdocs-git-authors-pluginfor displaying the authors from gitmkdocs-git-committers-pluginfor displaying authors' github user profilesSetupInstall the plugin usingpip3with the following command:pip3installmkdocs-git-revision-date-localized-pluginNext, add the following lines to yourmkdocs.yml:plugins:-search-git-revision-date-localizedIf 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.Themkdocs-materialtheme supportsgit-revision-date-localized. After installing the plugin and updating yourmkdocs.ymlyou should see the last revision date on the bottom of your pages. Other mkdocs themes requireadditional customization.See thedocumentationon how to fine-tune the appearance and the date format.Note when using build environmentsThis plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:Change your CI settingsgithub actions: setfetch-depthto0(docs)gitlab runners: setGIT_DEPTHto0(docs)bitbucket pipelines: setclone: depth: full(docs)DocumentationSeetimvink.github.io/mkdocs-git-revision-date-localized-plugin.ContributingContributions are very welcome! Please readCONTRIBUTING.mdbefore putting in any work.
Package: mkdocs-git-snippet
mkdocs-git-snippetMkdocs Plugin for snippet from git repository.Installationpipinstallmkdocs-git-snippetConfigurationEnable the plugin in your mkdocs.yml.plugins:-git-snippetIf the folder name that contain your documentation source files is not defaultdocs, you need specify it withbase_pathoption.plugins:-git-snippet:
        base_path: docsBy default, this plugin works for all pages. You can enable only for the specific page by settingall_pagesoption to false.plugins:-git-snippet:
      all_pages: falseWhenall_pagesis false, this plugin only works for the page that addedgit-snippet: enable.<!-- git-snippet: enable --># Your document....Acessing Private RepositoriesTo add a snippet from a private repository set theGITHUB_TOKENenvironment variable while building mkdocs documentation.UsageAll files from default branch{{ gitsnippet('mkdocs/mkdocs', 'docs/user-guide/plugins.md') }}It works for non markdown file too. The snippet format is raw text.
Please format it if needed.```python
{{ gitsnippet('mkdocs/mkdocs', 'mkdocs/config/base.py') }}
```All files from specific branch/tag/commit```python
{ gitsnippet('mkdocs/mkdocs', 'mkdocs/config/base.py', '1.1')
``````python
{{ gitsnippet('mkdocs/mkdocs', 'mkdocs/config/base.py', '520314fed933aed8de62b08dd7fc6e25c0ff482b') }}
```Snippet a sectionFor markdown file, it is possible to specify a section.{{ gitsnippet('mkdocs/mkdocs', 'docs/user-guide/plugins.md', section='## Using Plugins') }}or{{ gitsnippet('mkdocs/mkdocs', 'docs/user-guide/plugins.md', 'master', '## Using Plugins') }}Insert indentYou can insert indent to snippet usingindent.indenthas an argumentwidth, which means the number of space to indent by. The default is 4.
See more details ofindenthere.??? example "Plugin.md"

    {{ gitsnippet('mkdocs/mkdocs', 'docs/user-guide/plugins.md') | indent }}

    !!! note

        ```python
        {{ gitsnippet('mkdocs/mkdocs', 'mkdocs/config/base.py) | indent(width=8) }}
        ```ContributionPlease read the CLA carefully before submitting your contribution to Mercari.
Under any circumstances, by submitting your contribution, you are deemed to accept and agree to be bound by the terms and conditions of the CLA.https://www.mercari.com/cla/LicenseCopyright 2021 Mercari, Inc.Licensed under the MIT License.
Package: mkdocs-gitsnippet-plugin
# AboutMkDocs plugin that allow to inject snippet or all markdown content from a given remote git repository.
The goal is to show different markdowns from different projects inside a MkDocs, you put together all info across some projects.## InstallationInstall the package with pip:`bash pip installmkdocs-gitsnippet-plugin`## ConfigurationEnable the plugin in yourmkdocs.ymlifyou didn’t change the folder name that contain your documentation source files.By defaultdocs.`yaml plugins: - gitsnippet `Enable the plugin in yourmkdocs.ymlifyou changed the folder name that contain your documentation source files. By defaultdocs.`yaml plugins: - gitsnippet: base_path: docs `> This package requires MkDocs version 0.17 or higher.## Usagemkdocs-gitsnippet-plugin will download the file you specify from a remote git repository, extract the section or all content and inject that into you MkDocs file at render time. It’s possible to specify brunch of repository### Snippet a sectionIf you want to extract a section from a remote git repository, you can add the following to your markdown in MkDocs:`markdown {{gitsnippet('git@github.com:SamazoOo/mkdocs-gitsnippet-plugin.git','README.md', '## Installation') }} `### All markdown contentIf you want to get all context from a markdown in a remote git repository, you can add the following to your markdown in MkDocs:`markdown {{gitsnippet('git@github.com:SamazoOo/mkdocs-gitsnippet-plugin.git','README.md', '') }} `### All markdown content and specify the name of the branchIf you want to get all context from a markdown in a remote git repository and get it from development brunch, you can add the following to your markdown in MkDocs:`markdown {{gitsnippet('git@github.com:SamazoOo/mkdocs-gitsnippet-plugin.git','README.md', '', 'development') }} `### Images referencesIf the remote file has references to images, those will also be downloaded and placed in a_genfolder in the mkdocs hierarchy. You will probably want to include**/gen_in your.gitignorefile so you don’t put those into your git repository unless you want them there.
Package: mkdocs-git-timeline-plugin
mkdocs-git-timeline-pluginLightweightMkDocsplugin to display git authors of a markdown page:Authors: Jane Doe, John DoeSee thedemo. The plugin only considers authors of the current lines in the page ('surviving code' usinggit blame).Other MkDocs plugins that use information from git:mkdocs-git-revision-date-localized-pluginfor displaying the last revision datemkdocs-git-committers-pluginfor displaying authors' github user profilesSetupInstall the plugin using pip3:pip3installmkdocs-git-timeline-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - git-timelineIf 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.You can then use the{{ git_page_authors }}tag in your markdown document, or choose to customize your mkdocs theme (seeusagepage in the docs).Note when using build environmentsThis plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:Change your CI settingsgithub actions: setfetch_depthto0(docs)gitlab runners: setGIT_DEPTHto1000(docs)bitbucket pipelines: setclone: depth: full(docs)DocumentationSeetimvink.github.io/mkdocs-git-timeline-pluginContributingVery much open to contributions! Please readcontributing guidebefore putting in any work.
Package: mkdocs-glightbox
MkDocs GLightboxA MkDocs plugin supports image lightbox withGLightbox.GLightbox is a pure javascript lightbox library with mobile support.Live demowithMaterial for MkDocs.DependencyGLightbox javascript file and CSS fileGLightbox==3.2.0UsageInstall the plugin from PyPIpipinstallmkdocs-glightboxAddglightboxplugin to your mkdocs.yml plugins sections:plugins:-glightboxAll images will be added to the lightbox effect automatically, except images in an anchor tag and emoji images frompymdown-extensions.You may customize the plugin by passing options in mkdocs.yml:plugins:-glightbox:touchNavigation:trueloop:falseeffect:zoomslide_effect:slidewidth:100%height:autozoomable:truedraggable:trueskip_classes:-custom-skip-class-nameauto_caption:falsecaption_position:bottombackground:whiteshadow:trueOptionDefaultDescriptiontouchNavigationtrueEnable or disable the touch navigation (swipe).loopfalseLoop slides on end.effectzoomName of the effect on lightbox open. (zoom, fade, none)slide_effectslideName of the effect on lightbox slide. (slide, zoom, fade, none)widthautoWidth for inline elements and iframes. You can use any unit for example 90% or 100vw for full width.heightautoHeight for inline elements and iframes. You can use any unit for example 90%, 100vh or auto.zoomabletrueEnable or disable zoomable images.draggabletrueEnable or disable mouse drag to go prev and next slide.skip_classes[ ]Disable lightbox of those image with specific custom class name.auto_captionfalseEnable or disable using alt of image as caption title automatically.caption_positionbottomDefault captions position. (bottom, top, left, right)backgroundwhiteThe background CSS of lightbox image. The background will shown when the image is transparent. You can use any CSS value for the background for example#74b9fforGainsboroornonefor nothing.shadowtrueEnable or disable the shadow of lightbox image. Disable it when the background isnoneto prevent shadow around the transparent image.Check more options information onGLightbox Docs.For more flexibility, you can disable the lightbox with aspecific imageor aspecific page.Support lightbox image caption, check more details onCaption.Support grouping images as galleries, check more details onGallery.How it worksCopy GLightbox script file intosite/assets/javascripts/directory and CSS file intosite/assets/stylesheets/directoryImport GLightbox script and CSS file and add javascript code on each page excluded disabled pagesSearch all image tags and warp with an anchor tag for GLightbox excluded images with skip class or already warped with an anchor tagLicenseThis project is licensed under the MIT License - see theLICENSE.mdfile for details.
Package: mkdocs-glightbox-tables
MkDocs GLightboxA MkDocs plugin supports image lightbox withGLightbox.GLightbox is a pure javascript lightbox library with mobile support.Live demowithMaterial for MkDocs.DependencyPython Packagebeautifulsoup4>=4.11.1GLightbox javascript file and css fileGLightbox==3.2.0UsageInstall plugin from pypipipinstallmkdocs-glightboxAddglightboxplugin to your mkdocs.yml plugins sections:plugins:-glightboxYou may customize the plugin by passing options in mkdocs.yml:plugins:-glightbox:touchNavigation:trueloop:falseeffect:zoomwidth:100%height:autozoomable:truedraggable:trueOptionDefaultDescriptiontouchNavigationtrueEnable or disable the touch navigation (swipe).loopfalseLoop slides on end.effectzoomName of the effect on lightbox open. (zoom, fade, none)width100%Default width for inline elements and iframes. You can use any unit for example 90% or 100vw for full width.heightautoDefault height for inline elements and iframes. You can use any unit for example 90%, 100vh or auto.zoomabletrueEnable or disable zoomable images.draggabletrueEnable or disable mouse drag to go prev and next slide.Check more options information onGLightbox Docs.For more flexibility, you can disable lightbox by aspecific imageor aspecific page.LicenseThis project is licensed under the MIT License - see theLICENSE.mdfile for details.
Package: mkdocs-glossary-plugin
mkdocs-glossary-pluginThis plugin provides a simple glossary feature for mkdocs.What's useful?When you are writing documents for your project, you maybe use some project-specific words.Of course, reader cannot understand these words without any explanation, but we want to avoid linking to all the places where these words are used.In these cases, this plugin can ...replace these words with a link to a specified page automaticallycontrol the details, such as not converting words contained in h1 or emph, but converting words contained in plain text.alias support. you can set alias for each word.Requirementspython >= 3.7pandoc >= 2.11python pandoc(https://pypi.org/project/pandoc/)How to installpython3 setup.py installGetting startedPlugin configurationEdit your mkdocs.yml file as follows.plugins:
  - mkdocs-glossary-plugin:
      glossary_dirs: ["foo", "bar"] # This plugin considers the md files in "docs/foo" and "docs/bar" as glossary files.You can set some options, see Options section.Register glossaryFor example, let's say you want to create a glossary of the wordx_word.At first, You have to createx_word.mdfile like below as a glossary page forx_word.~/mkdocs_project/docs$ tree
.
├── foo
│   └── x_word.md
└── index.mdAll that remains is for you to write freely in x_word.md!If you want to add an alias tox_word, set the glossary metadata at the beginning of the x_word.md file as follows.---
glossary: alias_word_a
glossary: alias_word_b
---

This is the glossary page for x_word!That's all! Now, all thex_word,alias_word_aandalias_word_bin your project will be replaced with a link to x_word.md when building.OptionsNameNecessaryTypeDefaultDetailglossary_dirsrequiredList[str]NoneSpecify the dirs containing the glossary md files. This plugin will only search for glossaries here.Please fill out with relative path from docs dir.input_formatoptionalstrmarkdown_phpextraThe input format of the markdown file. Seepandocoutput_formatoptionalstrmarkdown_phpextraThe output format of the markdown file. Seepandocenable_tocoptionalboolTrueIf True, you can use table of contents([TOC]) feature.replace_emphasized_textoptionalboolTrueIf True, emphaseized text includes specified word.replace_headeroptionalboolFalseIf True, h1,h2,.. includes specified word.replace_table_headeroptionalboolTrueIf True, table header includes specified word.replace_table_bodyoptionalboolTrueIf True, table body includes specified word.
Package: mkdocs-google-translate
mkdocs-google-translateA mkdocs plugin to add relative paths to Google Translate queriesInstall usingpip install mkdocs-google-translateUsageActivate the plugin inmkdocs.ymlby adding the following lines, replace the values of_x_tr_sland_x_tr_tlto match your site:extra:
  alternate:
      # Original Language
    - name: English
      lang: 'en'
      link: '%GT_RELATIVE_URL%'  # For relative urls back to original language
      # Extra languages
    - name: Norsk
      lang: 'no'
      link: 'https://translate.goog/?_x_tr_sl=en&_x_tr_tl=no'
      # _x_tr_sl = source language
      # _x_tr_tl = translation language

plugins:
  - search
  - google-translate:
      url: example.com  # optional (required for local testing)Note:If 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, but now you have to enable it explicitly.IncompatabilitiesThis plugin is somewhat incompatible with the mkdocs featurenavigation.instant, due to the fact that the page heading never changes with the feature enabled.
Package: mkdocs-graphviz
Project Page :rod2ik/mkdocs-graphvizSome rendering examples can be seen on these pages:Trees :https://eskool.gitlab.io/tnsi/donnees/arbres/quelconques/Graphs :https://eskool.gitlab.io/tnsi/donnees/graphes/definitions/This project is part of other mkdocs-related projects.If you're interested, please consider having a look at this page for a more complete list of all our mkdocs-related projects:https://eskool.gitlab.io/mkhack3rs/This project is the result of several independant participants :For All newer Credits: Rodrigo Schwencke atrod2ik/mkdocs-graphvizCesare Morel atcesaremorel/markdown-inline-graphviz, and before him,Steffen Prince atsprin/markdown-inline-graphviz,Initially inspired by Jawher Moussa atjawher/markdown-dotIn order to get it work with pip (python3) and mkdocs.If you use python 2, please consider using the original extension instead.Licences:All newer parts (Rodrigo Schwencke) areGPLv3+Older parts (Cesare Morel, Steffen Prince, Jawher Moussa) areMIT License
Package: mkdocs-helm
Mkdocs Helm PluginAn Mkdocs Plugin to turn github pages as an helm repo.How to useAdding helm-repo plugin into mkdocs.yaml and configure it.plugins:-helm-repo:chart:alb-ingress-controller-helmSupported plugin configurations:chart: Required, path to your helm chart from root directory.chart_dir: Optional(default to 'charts'), http path to host your actual chartshelm_repo_url: Optional(default to github pages), intended helm repository urlSupported environment variables:HELM_BIN: Optional(default to 'helm') path to your helm binaryGIT_BIN: Optional(default to 'git') path to your git binary
Package: mkdocs-heti-plugin
mkdocs-heti-plugin一个使用heti来优化 mkdocs 中文正文排版的插件。具体表现在：中西文混排间使用四分宽空格注：与 heti 不同，此时复制得到的是带半角空格的文本，而 heti 原脚本复制下来不带空格进行连续标点的挤压预览：https://note.tonycrane.cc/提示heti 原本是跑在前端的，不过在加载出页面到 heti 处理好之间有一小段时间间隔，感觉有些不爽，就写了这个插件，将这个任务直接放到网站生成的时候来做。不过嘛，效率是极低的，我的 note 用上之后需要三分多钟才能完成网站构建。如果可以忍受在前端处理的话可以看这个 commit：TonyCrane/note@5a0259安装可以通过 pypi 直接安装：$pipinstallmkdocs-heti-plugin也可以从源码安装$gitclonehttps://github.com/TonyCrane/mkdocs-heti-plugin.git
$cdmkdocs-heti-plugin
$pipinstall.# or pip install -e .使用在 mkdocs.yml 中启用插件即可：plugins:-heti由于效率实在是太低，所以默认在 serve 的时候不进行处理，想要处理的话这样写：plugins:-heti:disable_serve:false目前配置项配置的不多，用法啥的也以后再完善（咕咕咕开发mkdocs_heti_plugin/utils/finder.py是我对着padolsey/findAndReplaceDOMText的 js 代码扒出来的，我也不敢说我看懂了，反正它目前确实能跑，能用就行了。mkdocs_heti_plugin/utils/heti.py里面有一些用很不优雅的方式解决的一些不想深究的 bug，有时间再细看看。有想修改、改进的我非常且热烈欢迎，尽管 PR 就好（TODO与 mkdocs-encryptcontent-plugin 加密页面兼容支持 pymdownx.arithmatex注意事项与 mkdocs-encryptcontent-plugin 还没兼容，加密的页面目前不做处理（处理的话目前会卡死）。参考 & 鸣谢sivan/hetipadolsey/findAndReplaceDOMText
Package: mkdocs-homepage-copier
MkDocs Homepage CopierReuse theREADME.mdfile by copying it into thedocs/directory as thedocs/index.mdfileLintingIsort, black, and flake8 are used to check that code is well formatted and styled. Pre-commit hooks are used to automate
this process.Install pre-commit package:pip install pre-commitInstall git hook scripts:pre-commit install(optional) Run against all files:pre-commit run --all-filesTestingTo run tests:Install pytest and coverage:pip install pytest coverageRun tests:coverage run --source="copier" -m pytest(optional) View coverage report:coverage reportUsageInstall the package via pip:pip install mkdocs-homepage-copierOr install the package from source:git clone https://github.com/onyonkaclifford/MkDocs-homepage-copier.gitcd MkDocs-homepage-copierpip wheel --no-deps . -w distpip install dist/mkdocs_homepage_copier-{version}-py3-none-any.whlEnable the plugin inmkdocs.yml:plugins:-search-mkdocs-homepage-copiernav:-Home:index.mdIf the file to be copied is not namedREADME.mdand/or the destination path isn'tdocs/index.md, use the parameterssrcanddestto identify the correct file to be copied and the correct destination path it's to be copied to. Either
one, both, or none of the two parameters can be used depending on the need.plugins:-search-mkdocs-homepage-copier:src:source.mddest:path/to/destination.mdnav:-Navigation option:path/to/destination.mdTo disable mkdocs-homepage-copier, set thecopyparameter tofalse. To re-enable, set it totrueor remove it frommkdocs.yml, as it's set totrueby default.plugins:-search-mkdocs-homepage-copier:copy:falseTo copy extra files in addition to the homepage file, use theextrasparameter.plugins:-search-mkdocs-homepage-copier:src:source.mdcopy:falseextras:-src:path/to/source1.mddest:path/to/destination1.mdcopy:true-src:path/to/source2.mddest:path/to/destination2.mdcopy:false
Package: mkdocs-i18n
MkDocs i18n pluginA plugin to internationalize MkDocs. It adds links to translated pages for each page. It also hides other languages page links of navigation menu if there is a translation for current page language.Example of mkdocs-i18n usage:https://mkdocs-i18n.gitlab.io/mkdocs-i18nFeel free to write your comments or request adaptations to your requirements athttps://gitlab.com/mkdocs-i18n/mkdocs-i18n/-/issues.mkdocs-i18n updatesSite Language of Material for MkDocsifit is enabled.mkdocs-i18n updatesSite Language Selector of Material for MkDocslinking each translated page ifit is configured.Case Studieshttp://isardvdi.com(https://isard.gitlab.io/isardvdi-docs) is a multilingual community, most members know 2 languages but not the same ones, some understand 3... Each one has its favorite language and has different levels of knowledge about other languages. In addition, community documentation doesn't have a source language and not all documents need to be translated into all languages. Therefore, this plugin shows all available translations for the page shown at the top of the document and also for pages not translated into the language selected in the navigation menu.SetupInstall the plugin using pip:pip install mkdocs-i18nConfigure the plugin viamkdocs.ymlIf you have nopluginsentry in your configuration file you havesearchplugin enabled. If you createpluginsentry to enablei18nplugin you also need to addsearchplugin if you want to havesearchplugin enabled.Donations:LiberapayBitcoinOther interesting works:MkDocs static i18n plugin: Builds a parallel structure of translated documents with a source language. It does not link to other translations of the current document and does not show pages that have not been translated into the current language or the default language. Therefore, documents translated only into a non-default language are only linked to the navigation menu when visiting a page with the same language.MkDocs Theme i18n: Work in progress.Markdown i18n plugin: Provide translation of documents via po files but images cannot be localized.MkDocs Multilang: Only released for MkDocs < 1.0
Package: mkdocs-iframe
MkDocs Iframe PluginMkDocs plugin to integrate HTML reports into your site.
This is a modified version ofmkdocs-coverage.InstallationWithpip:pipinstallmkdocs-iframeWithpipx:python-mpipinstall--userpipx
pipxinstallmkdocs-iframeUsageYou first need generate your html test reports. For example, usingpytest-covandpytest-html:pytest--cov--html=htmltest/index.htmltests
coveragehtmlwill generate two report directorieshtmlcovandhtmltest.Now update yourMkDocsconfig:# mkdocs.ymlnav:-Coverage report:cov.md# Needs to match page from below-Test report:test.md# Needs to match page from belowplugins:-iframe:reports:-name:covpath:htmlcov# default f"html{name}"root:index.html# defaultpage:cov.md# f"{name}.md"-name:testpath:htmltest# default f"html{name}"root:index.html# defaultpage:test.md# f"{name}.md"Give the default settings, you could also use the following, simpler config:# mkdocs.ymlnav:-Coverage report:cov.md-Test report:test.mdplugins:-iframe:reports:-cov-testNow serve your docs and go tohttp://localhost:8000/cov/orhttp://localhost:8000/test/to see your test report.
Package: mkdocs-image-captions
MkDocs ImageCaptions PluginPlugin forMkDocsthat converts markdown encoded images to HTMLelement with captions.ExampleInput MD Template:![Informative image caption](/docs/assets/images/image.png)Output:<figureclass="figure-image"><imgsrc="/docs/assets/images/image.png"alt="Informative image caption"><figcaption>Informative image caption</figcaption></figure>Plugin installationTo enable the plugin, add the following line to yourmkdocsconfig filemkdocs.yml:plugins:-mkdocs-image-captionsLocal developmentDependencies installationThe package requires Python >= 3.8 and Poetry >= 1.4.0.Project installationInstall required packagespoetry installNow you can activate Poetry and make your changes:poetry shellRun testsActivate virtualenv:poetry shellRun tests:python tests/test_plugin.pyUpdate package on PyPI with poetryBuild new package versionpoetry buildPush to PyPIpoetry publishNote:to push packages into PyPI you need to provide auth token:export POETRY_PYPI_TOKEN_PYPI=<your token>