Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-img2fig-plugin
MkDocs Img2Fig PluginThisMkDocsplugin converts markdown encoded images like![An image caption](\assets\images\my-image.png)into<figureclass="figure-image"><imgsrc="\assets\images\my-image.png"alt="An image caption"><figcaption>An image caption</figcaption></figure>RequirementsThis package requires Python >=3.5 and MkDocs version 1.0 or higher.InstallationInstall the package with pip:pip install mkdocs-img2fig-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-img2figNote: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.More information about plugins in theMkDocs documentation
Package: mkdocs-img2fig-plugin-with-icons
MkDocs Img2Fig PluginThisMkDocsplugin converts markdown encoded images like![An image caption](\assets\images\my-image.png)into<figureclass="figure-image"><imgsrc="\assets\images\my-image.png"alt="An image caption"><figcaption>An image caption</figcaption></figure>RequirementsThis package requires Python >=3.5 and MkDocs version 1.0 or higher.InstallationInstall the package with pip:pip install mkdocs-img2fig-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-img2figNote: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.More information about plugins in theMkDocs documentation
Package: mkdocs-img2figv2-plugin
MkDocs Img2Fig v2 Pluginthis project fix bug and add new feature inMkDocs Img2Fig pluginThisMkDocsplugin converts markdown encoded images like![An image caption](../images/my-image.png){align="right" width="20%"}into<figureclass="figure-image"><imgsrc="../../images/my-image.png"alt="An image caption"align="left"width="20%"><figcaption>An image caption</figcaption></figure>of course, you could leave out{align="right" width="20%"}support attr :https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/imgcenter imageunfortunately,align:centeris not supported. if you want to center image, addstyle="display:block; margin:0 auto;for example![An image caption](../images/my-image.png){width="20%" style="display:block; margin:0 auto;"}RequirementsThis package requires Python >=3.6 and MkDocs version 1.0 or higher.InstallationInstall the package with pip:pip install mkdocs-img2figv2-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-img2figv2Note: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.More information about plugins in theMkDocs documentationKnown issueit won't work with settinguse_directory_urls: falsein yourmkdocs.yml( true is default )
Package: mkdocs-img2figv3-plugin
MkDocs Img2Fig v3 Pluginthis project fix bug and add new feature inMkDocs Img2Fig pluginThisMkDocsplugin converts markdown encoded images like![An image caption](../images/my-image.png){align="right" width="20%"}into<figureclass="figure-image"><imgsrc="../../images/my-image.png"alt="An image caption"align="left"width="20%"><figcaption>An image caption</figcaption></figure>of course, you could leave out{align="right" width="20%"}support attr :https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/imgcenter imageunfortunately,align:centeris not supported. if you want to center image, addstyle="display:block; margin:0 auto;for example![An image caption](../images/my-image.png){width="20%" style="display:block; margin:0 auto;"}RequirementsThis package requires Python >=3.6 and MkDocs version 1.0 or higher.InstallationInstall the package with pip:pip install mkdocs-img2figv3-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-img2figv3Note: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.More information about plugins in theMkDocs documentationThis plugin also fixed the known issue inmkdocs-img2figv2-plugin. It now works withuse_directory_urls: falseinmkdocs.yml.
Package: mkdocs-import-statement-plugin
mkdocs-import-statement-pluginThis plugin is forMkDocsto add capability of@import "file"statement to directly insert various files into a page.Supported file typesAs image file type, following extensions are supportedExtensionFile typeBehavior.jpegJPEGImage.jpg^^.gifGraphics Interchange Format^.pngPortable Network Graphics^.apngAnimated Portable Network Graphics^.svgScalable Vector Graphics^.bmpWindows bitmap^Following extensions are also supported.ExtensionFile typeBehavior.csvComma-Separated ValuesTable.jsJavaScriptJavaScript.mdMarkdownMarkdown.htmlHTMLText.htm^^.mermaidMermaidComment.dotDOT^.pumlPlantUML^.pu^^InstallationInstall the plugin usingpip:pipinstallmkdocs-import-statement-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - import-statementIf 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.UsageIn your markdown documents you can describe as following.@import "file"When you use MkDocs, this plugin will replace these import statements appropriately depending on the extension.Image fileThe import statement is replaced as following.![](file)If there are{}options after the import statement, that statement will be replaced with a<img>tag.For example,@import "file" {width="640" height="480"}is converted to as follwoing.<imgsrc="file"width="640"height="480">Where the image file path is relative to the markdown file.Table fileThe import statement is replaced with a Markdown table that expands the contents of the specified file.For example, when the following CSV file is as following.A1,B1,C1
A2,B2,C2
A3,B3,C3This replaced to as following.| A1 | B1 | C1 |
| :- | :- | :- |
| A2 | B2 | C2 |
| A3 | B3 | C3 |JavaScript fileThe import statement is replaced with<script>tag like as following.<scripttype="text/javascript"src="file"></script>Markdown fileThe import statement is replaced with the contents of the specified file and the replacement is recursively processed.Text fileThe import statement is replaced with the contents of the specified file.Comment fileThe import statement is replaced by comment blocks of the contents of the specified file.
Package: mkdocs-include
File include plugin for mkdocsThis repo was forked frommkdocs-excludeplugin.mkdocs-includeis amkdocs pluginthat allows you
to include files from your input using unix-style wildcards (globs) or
regular expressions (regexes).This implements what people were asking for in some mkdocs bugs, such ashttps://github.com/mkdocs/mkdocs/issues/1500andhttps://github.com/mkdocs/mkdocs/issues/1152.Quick startInstall the module using pip:pip3 install mkdocs-includeIn your project, add a plugin configuration tomkdocs.yml:plugins:-includeorplugins:-include:glob:-include/this/path/*-"*.tmp"-"*.pdf"-"*.gz"regex:-'.*\.(tmp|bin|tar)$'You can provide zero or more patterns of each type.  (If you don't provide
any patterns, then nothing will happen!)Note!  Because of peculiarity of yaml syntax, theglob:andregex:linesmust notstart with a dash, but the lines under themmuststart with
a dash.Also because of yaml, patterns that start with a punctuation mark must be
quoted.When writing regexes, it's best to use single quotes rather than double
quotes, so that your regex backslash escapes are preserved correctly without
having to be doubled up.
Package: mkdocs-include-exclude-files
mkdocs_include_exclude_filesBy default, mkdocs copies everything it can find in thedocs_dirdirectory that doesn't start with a.This plugin allows for customising that.Installationpipinstallmkdocs_include_exclude_filesRequires MkDocs 1.2.3+ and Python 3.8+UsageInmkdocs.yml:plugins:
    - search  # default plugin, need to re-enable when using manual plugins
    - include_exclude_files:
        - include:
            - ".some_file"
            - ".anotherfile"
        - exclude
            - "some_folder"
            - "anotherfolder"Every file exactly matching those inincludewill be included. Any file whose locationstarts withanything inexcludewill be excluded.
Package: mkdocs-include-folders
Folder include plugin for mkdocsmkdocs-include-foldersis amkdocs pluginthat allows you
to include and prioritize folders from your input.Quick startInstall the module using pip:pip3 install mkdocs-include-foldersIf your document folders look like this:documents
   project1
      mkdocs.yml
      specifications.md
   project2
      mkdocs.yml
      specfications.md
   shared-docs
      introduction.md
      contact.md
      .....you may want to create a document including pages from theproject1andshared-docsand present them in the same folder, this plugin will take documents fromproject1andshared-docsand place the im the same folder and also proritize files inproject1over files inshered-docsif they have the same name.In your project, add a plugin configuration tomkdocs.yml:docs_dir:..plugins:-include-foldersordocs_dir:..plugins:-include-folders:priority_path:-'project1/*'-'shared-docs/*'You can provide one or more patterns.  (If you don't provide any patterns,
then nothing will happen!)Note!  Because of peculiarity of yaml syntax, theglob:andregex:linesmust notstart with a dash, but the lines under themmuststart with
a dash.Also because of yaml, patterns that start with a punctuation mark must be
quoted.When writing regexes, it's best to use single quotes rather than double
quotes, so that your regex backslash escapes are preserved correctly without
having to be doubled up.
Package: mkdocs-inline-select-svg-plugin
mkdocs-plugin-inline-select-svgAMkDocs pluginthat inlines SVG images matching a pattern into the output without inlining Materials theme icons.This operates post HTML generation looking forimgelements like<imgsrc="foo.svg"...>When thesrcis a path-local URL with a path component that ends
with.svgand it matches the configured pattern then the file is
read from the local file system and inlined in place.Alt text is ignored in favour of any SVG<title>element.If the SVG contains any elements marked withclass="do-not-inline",
they will not be included in the inlined content.
This is useful when your SVG images contain<style>elements that
you do not want to bleed into the containing scope, and your Mkdocs
configuration includes extra CSS stylesheets that suffice.UsageTo download and install this module, run:pipinstallmkdocs-inline-select-svg-pluginEnable the plugin in yourmkdocs.ymlby addinginline-select-svgas a list item under thepluginssection.  Since that section will almost certainly includesearchyou might end up with something like this:plugins:-search-inline-select-svgIf you want to filter which SVGs to inline, by path, you can specify a regular expression using thepatternconfig option thus:plugins:-search-inline-select-svg:pattern:"[.]inline[.]svg$"With that configuration,<img src="../foo.inline.svg">would be
inlined but<img src="../foo.svg">would not.
Package: mkdocs-inline-svg-plugin
NOTE:this project is still WIP!mkdocs-inline-svg-pluginTable of ContentsInstallationLicenseInstallationpip install mkdocs-inline-svg-pluginLicensemkdocs-inline-svg-pluginis distributed under the terms of theMITlicense.UsageIf you want to inline SVGs, that were put inimgtags by thekroki plugin:mkdocs.yml:plugins:-kroki:FencePrefix:''HttpMethod:'POST'DownloadImages:true-inline-svg:AltName:KrokiConfigurationConfig valueWhat forAltNamedefault:*, that does not check theimgaltpropertyIncludeAssetsdefault:False, looks forurl(..), downloads the contents toAssetDirand replaces the urlAssetDirdefault:assets/PatchStyledefault:False, this feature isEXPERIMENTALand not yet finished, needs an additional CSSTestServe documentation:hatchrundocs:serve
Package: mkdocs-iolanta
📖mkdocs+ 👁️iolantaFeaturesBy integrating MkDocs static site builder with Iolanta knowledge management workspace, you can empower your static site with:Automatic page → page🔗 links;Tablesgenerated from YAML data;Projectroadmaps;Architecture Decision Records.Something missing? Or anything doesn't work? Submit➕ an issue!InstallationPython ⩾ 3.10 required.mkdocs-iolantais onPyPI.pipinstallmkdocs-iolantaConfigurationOpen yourmkdocs.ymlconfiguration file and configure itspluginssection as follows:plugins:-search# (1)!-…-iolanta# (2)!-macros:# (3)!on_error_fail:true# (4)!-…Thesearchplugin is built-in and automatically enabled ifmkdocs.ymldoes not specify anypluginsat all. But if it does, this built-in plugin must be enabled explicitly.Supportiolantacapabilities for this documentation site.This enablesmkdocs-macros-pluginwhich is required to utilize Iolanta capabilities on MkDocs pages, such as {{ render("render") }} macro.This setting is highly recommended. If there is an error during rendering MkDocs macros, including those macros provided by Iolanta, the site build will throw an error — making the issue easier to notice both on local development and in CI.
Package: mkdocs-iolanta-tables
octadocsFeaturesFully typed with annotations and checked with mypy,PEP561 compatibleAdd yours!InstallationpipinstalloctadocsLicenseMITCreditsThis project was generated withwemake-python-package. Current template version is:868260c2d659e455bafc2ed4fe242413ef39e4dc. See what isupdatedsince then.
Package: mkdocs-izsam-search
mkdocs-search-izsamThis is a MkDocs plugin that extends native search plugin in order to allow searches work locally. It will write two .js files (one storing a variable forconfigand one storing a variable fordocs) that can be loaded in the theme using:<scriptsrc="{{ 'search/search_config.js'|url }}"></script><scriptsrc="{{ 'search/search_docs.js'|url }}"></script>This will allow to avoid CORS problem caused byloadJSONfunctions and nativeworker.jsmodel.Important!To use .js features and bypass the nativeworker.jsmodel, the theme should be configured to use thesearch_index_onlyoption astrue:theme:name:nullcustom_dir:your_custom_themeinclude_search_page:truesearch_index_only:trueand then manage search with your favourite js library (in our project we still uselunr.jsloaded in a script tag in the theme). For additional information please refer tohttps://www.mkdocs.org/dev-guide/themes/#search-and-themes.SetupInstall the plugin using pip:pip install mkdocs-izsam-searchActivate the plugin inmkdocs.yml:plugins:-izsam-searchIt is possible to use same config options of the native search plugin:-izsam-search:lang:enMore information about plugins in theMkDocs documentation.See AlsoChange log[0.1.8] - 2021-11-10Implementation of the main feature: build .js files to allow local search and avoid CORS problemsAdded necessary code in plugin.pyAdded instruction on README.md[0.1.7] - 2021-11-10Configuration errorConfiguration error: mkdocs_izsam_search.search_index.SearchIndex must be a subclass of mkdocs.plugins.BasePlugin. Changed search_index.py[0.1.6] - 2021-11-10Configuration errorConfiguration error: mkdocs_izsam_search.search_index.SearchIndex must be a subclass of mkdocs.plugins.BasePlugin. Changed entry_points in setup.py[0.1.5] - 2021-11-10Setupdifferent syntax for setup()[0.1.4] - 2021-11-10Setupentry_points declaration in setup()[0.1.3] - 2021-11-10Debug on MANIFEST.inModifiedMANIFEST.inthere was an error causing import data issues[0.1.2] - 2021-11-10EditedREADME.md[0.0.1] - 2021-11-10AddedHISTORY.md
Package: mkdocs-izsam-video
MkDocs IZSAM VideoThis plugin is based on the Mikalai Lisitsa idea, please visit the page of the project athttps://pypi.org/project/mkdocs-video/.The plugin allows you to embed videos on the documentation pages using a simple Markdown syntax. This plugin allows to embed videos only in a<video>tag, if you need<iframe>or YouTube or third parties videos embed, please refer to Mikalai Lisitsaplugin.InstallationInstall the package with pip:$pipinstallmkdocs-izsam-videoEnable the plugin in themkdocs.ymlfile:plugins:-mkdocs-izsam-videoSee how to useMkDocs PluginsUsageTo add a video to the final documentation page, you need to use the Markdown syntax for images with aspecific name(hereinaftermarker).See how to useMarkdown syntaxExample:content folder structure├── content
|   ├── ...
│   ├── video.md
│       └── videos
│           └── your-video.mp4
└── mkdocs.ymlvideo.mdUse relative paths for videos stored together with your content# Video example

Lorem ipsum dolor sit amet

![type:video-tag](./videos/your-video.mp4)ConfigurationMarkerBy default, the stringtype:video-tagis used as amarkerin the Markdown syntax.You can change this value by adding the following lines to yourmkdocs.yml:plugins:-mkdocs-izsam-video:mark:"your-marker"Now you can use thismarkerin the Markdown syntax:![your-marker](./videos/your-video.mp4)MarkerBy default, the following CSS styles are used for the<video>tag that is inserted into the final page:width:100%;You can change the style by adding the following lines to your mkdocs.yml:LicenseThe MIT License (MIT)Copyright (c) 2021 Alessandro De LucaPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.Change log[1.0.3] - 2022-11-24README update[1.0.2] - 2022-05-2Bug fix in plugin.py[1.0.1] - 2022-04-28Read me changesTypos and sentences correction[1.0] - 2022-02-02First releasemodified base plugin mkdocs-video to use HTML5 video tag
Package: mkdocs-jconfig-plugin
mkdocs-jconfig-pluginThis MkDocs plugin allows to process configuration variables usingJinjatemplates.InstallationInstall the package with pip:pipinstallmkdocs-jconfig-pluginActivate the plugin inmkdocs.yml:plugins:-search-calendar-jconfigConfigurationThe plugin can be configured in thepluginssection ofmkdocs.ymlas follows:plugins:-search-calendar-jconfig:items:-copyrightThe plugin supports the following configuration options:OptionDescriptionitemsThe configuration variables to process. Defaults to[].Typical usageThis plugin is useful when you want to automatically adjust the year in the copyright:copyright:copyright {{ cal.today.year }} The Authorsplugins:-search-calendar-jconfig:items:-copyrightNote that you need to activate thecalendarplugin for this to work.
Package: mkdocs-ko-fi-button-plugin
MkDocs Ko-fi Button PluginAn MkDocs plugin that let's you easily add a Ko-fi buttons with markdownThe plugin looks for Jinja style tags like{{ko-fi}}and replaces it with a Ko-fi button. It is possible to configure the text and color of the button.SetupInstall the plugin using pip:pipinstallmkdocs-ko-fi-button-pluginActivate the plugin inmkdocs.yml:plugins:-search-ko-fi-buttonConfigMandatoryid- Your Ko-fi ID. Can be found on your Ko-fi profile.Optionaltype- The type of button. Valid values are "widget" or "image". Default: widgetcolor- The color of the button.Iftype == 'widget': In hex format. Default: #29abe0Iftype == 'image': Either "blue", "bluegray", "red", "green" or "black". Default: bluegraytext- The text on the Ko-fi button.Iftype == 'widget': Default: "Support Me on Ko-fi"Iftype == 'image': Whatever text they have in the image.For example:plugins:-search-ko-fi-button:id:"my_id"text:"My cool text"color:"#547884"Note:Some MkDocs theme CSS conflicts with the widget styling. If that is the case and you cannot or will not update the CSS, thetypeconfig is useful. Set that to "image" and it should render properly. There will be no wiggly coffe mug though.Advanced configIn case the Ko-fi javascript is changed on the server side it is possible to configure the path and function calls. This will make it possible to still be able to get a working Ko-fi button widget until this plugin has been updated.javascript_path- The relative path to the javascript fromhttps://ko-fi.com/. Default: "widgets/widget_2.js"javascript_f1- The init function. Default: "kofiwidget2.init"javascript_f2- The draw function. Default: "kofiwidget2.draw"Note:These config options are only valid iftypeis set to "widget". They are ignored otherwise.
Package: mkdocs-kpn
KPN for MkDocsCreate a beautiful KPN project documentationKPN Theme is a theme for MkDocs, an excellent static site generator geared towards project documentation.
It is built usingKPN Styles.QuickstartInstall the latest version of KPN theme with pip:pipinstallmkdocs-kpnAppend the following line to your project's mkdocs.yml:theme:name:'kpn'What to expectResponsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way.Support for a lot of markdown extensions.Change repo icon# options: github | gitlab | bitbucket | giteaextra:repo_icon:'github'Add version to siteEditmkdocs.ymlwithextra:version:provider:'manual'version:1.2.2
Package: mkdocs-kroki-plugin
mkdocs-kroki-pluginThis is a MkDocs plugin to embed Kroki-Diagrams into your documentation.SetupInstall the plugin using pip:pip install mkdocs-kroki-pluginActivate the plugin inmkdocs.yml:plugins:...- kroki:ConfigKeyDescriptionServerURLURL of your kroki-Server, default:https://kroki.ioFencePrefixDiagram prefix, default:kroki-EnableBlockDiagEnable BlockDiag (and the related Diagrams), default:TrueEnablebpmnEnable BPMN, default:TrueEnableExcalidrawEnable Excalidraw, default:TrueEnableMermaidEnable Mermaid, default:TrueEnableDiagramsnetEnable diagrams.net (draw.io), default:FalseHttpMethodHttp method to use (GETorPOST), default:GET(Note: OnPOSTthe retrieved images are stored next to the including page in the build directory)FileTypesFile types you want to use, default:[svg], (Note: not all file formats work with all diagram typeshttps://kroki.io/#support)-kroki:FileTypes:-png-svgFileTypeOverrides- Overrides for specific diagrams to set the desired file type default: None,-kroki:FileTypeOverrides:mermaid:pngUsageUse code-fences with a tag of kroki-<Module>to replace the code with the wanted diagram.Diagram optionscan be set as well.Example for BlockDiag:```kroki-blockdiagno-transparency=falseblockdiag {blockdiag -> generates -> "block-diagrams";blockdiag -> is -> "very easy!";blockdiag [color = "greenyellow"];"block-diagrams" [color = "pink"];"very easy!" [color = "orange"];}```You can render diagram from file with@from_file:directive:```kroki-bpmn@from_file:path/to/diagram.bpmn```See AlsoDiagram examples can be foundhere.More information about installing a self-manged Kroki-Servicehere.More Plugins for MkDocs can be foundherePre-Release-VersionsInstall the newest pre-release version using pip:pip install -i https://test.pypi.org/simple/ mkdocs-kroki-plugin