Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-plantuml
Plantuml Techdoc embedded tool for MkDocsAllows you to co-locate your plantuml and have it embedded into your tech docsHow to useFirst install the packagepip install mkdocs-plantumlEnable in mkdocsplugins:-plantuml-colocatorOnce installed, link to plantuml in markdown![Alt Text](my-diagram.puml)Place the .puml source file in the same directory as the markdown (co-located)
Package: mkdocs-plantuml-local
MkDocs PlantUML LocalRender Plantuml codeblocks in mkdocs without sending sensitive diagrams to a public server.ConfigurationMinimalplugins:-plantuml-localmarkdown_extensions:-pymdownx.superfences:custom_fences:-name:plantumlclass:plantumlformat:!!python/name:pymdownx.superfences.fence_code_formatAllplugins:-plantuml-local:# shortname is language used to identify# blocks to process, defaults to `plantuml`shortname:puml# background_colour sets the background# fill colour used, defaults to `transparent`background_colour:white# class_name is the css class to assign to the# rendered svg diagram, by default no class# name is set.class_name:plantuml-diagram# cache, when set to true, will cache rendered# diagrams under the folder `.cache`. Not# recommended for use in CI, so add `.cache`# to your .gitignorecache:truemarkdown_extensions:-pymdownx.superfences:custom_fences:-name:pumlclass:pumlformat:!!python/name:pymdownx.superfences.fence_code_formatLicenceThis MkDocs plugin is licenced under the MIT license.Plantuml is redistributed with this package, under theGPL-3.0 license.
Package: mkdocs-plotly-plugin
Mkdocs Plotly PluginMkDocsplugin to create interactive charts from data using the declarativeplotly's json syntax.Includes supports formkdocs-materialtheme features likeinstant loadinganddark color themes.InstallationInstall the plugin usingpip3:pipinstallmkdocs-plotly-pluginAnd then add the plugin intopluginsand the custome fenceplugins:
  - plotly

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: plotly
          class: mkdocs-plotly
          format: !!python/name:mkdocs_plotly_plugin.fences.fence_plotlyUsageYou can insert any valid plotly JSON as a codeblock using:``` plotly
{
    "data": [
        {
            "x": ["giraffes", "orangutans", "monkeys"],
            "y": [20, 14, 23],
            "type": "bar"
        }
    ]
}
```This is compatiable withsnippletsas well```plotly
--8<-- "assets/data.json"
```or you can insert any plotly JSON through URLs```plotly
{"file_path": "./assets/data.json"}
```Usingsnippletswill insert the json content into the output HTML file, which is more suitable for smaller datasets. Usingfile_pathwill fetch the json content once the page is loaded.Plotly has its own eco-system for creating charts in most statistical languages. You can output the plot as a json file throughfig.to_json().OptionsOptionDefaultDescriptionlib_pathRelative path to localplotly.jsfile, or leave it blank to use CDN.template_defaultplotly_mintemplate for plotly charts in light modetemplate_slateplotly_dark_mintemplate for plotly charts in dark modeenable_templateTrueuse template to automatically change themeAvailable Plotly templates are["plotly_min", "plotly_dark_min", "plotly", "plotly_white", "plotly_dark", "ggplot2", "seaborn", "simple_white", "none"]. If you want to customize your own template, you can export it as a JSON file and provide its relative path in options.
Package: mkdocs-plugin-commonmark
mkdocs-plugin-commonmarkA plugin for mkdocs that swaps python-markdown for mistletoe to bring CommonMark support to mkdocs. Please note, this plugin monkey-patches mkdocs as there are not plugin hooks for changing the renderer.The majority of the code to support this plugin comes from the development Andy Pan did to fork mkdocs to add commonmark support. This plugin eliminates the need for a fork, but given that is closely coupled to mkdoc internals, it may break on a subsequent mkdoc release. It has currently been tested with version 1.1.2 of mkdocs.
Package: mkdocs-plugin-inline-ext-svg
mkdocs-plugin-inline-svgReads SVG images referenced from Markdown and replaces them with the SVG
file contentSince the SVG is included as part of the plain-text input to MkDocs, this means
the default MkDocs search supports searching SVG text, and hyperlinks are also
fully functional.UsageInstall the package with pip:pip install mkdocs-plugin-inline-svgEnable the plugin in your mkdocs.yml:plugins:
    - search
    - inline-svgNote: If you have no plugins entry in your config file yet, you'll likely
also want to add the search plugin. MkDocs enables it by default if there is
no plugins entry set, but now you have to enable it explicitly.More information about plugins in the MkDocs documentationOptionsYou can filter with the extension to select files to be inline. Useful to mix regular and inlined svgs.:plugins:
    - search
    - inline-svg:
        extension: ".inline.svg"Buildpip install build
python -m buildCreditsForked from Craig Roberts / mkdocs-plugin-inline-svgI am not really a Python programmer, so I have borrowed plugin setup / utils /
inspiration from:https://github.com/stuebersystems/mkdocs-img2fig-pluginhttps://github.com/athackst/mkdocs-simple-plugin
Package: mkdocs-plugin-inline-svg
mkdocs-plugin-inline-svgReads SVG images referenced from Markdown and replaces them with the SVG
file contentSince the SVG is included as part of the plain-text input to MkDocs, this means
the default MkDocs search supports searching SVG text, and hyperlinks are also
fully functional.UsageInstall the package with pip:pip install mkdocs-plugin-inline-svgEnable the plugin in your mkdocs.yml:plugins:
    - search
    - inline-svgNote: If you have no plugins entry in your config file yet, you'll likely
also want to add the search plugin. MkDocs enables it by default if there is
no plugins entry set, but now you have to enable it explicitly.More information about plugins in the MkDocs documentationCreditsI am not really a Python programmer, so I have borrowed plugin setup / utils /
inspiration from:https://github.com/stuebersystems/mkdocs-img2fig-pluginhttps://github.com/athackst/mkdocs-simple-plugin
Package: mkdocs-plugin-inline-svg-mod
mkdocs-plugin-inline-svg-modReads SVG images referenced from Markdown and replaces them with the SVG
file contentSince the SVG is included as part of the plain-text input to MkDocs, this means
the default MkDocs search supports searching SVG text, and hyperlinks are also
fully functional.UsageInstall the package with pip:pip install mkdocs-plugin-inline-svg-modEnable the plugin in your mkdocs.yml:plugins:
    - search
    - inline-svgNote: If you have no plugins entry in your config file yet, you'll likely
also want to add the search plugin. MkDocs enables it by default if there is
no plugins entry set, but now you have to enable it explicitly.More information about plugins in the MkDocs documentationOptionsYou can filter with the extension to select files to be inline. Useful to mix regular and inlined svgs.:plugins:
    - search
    - inline-svg:
        extension: ".inline.svg"
        delete: "<regex-string>"The delete parameter will remove the matching string from the SVG file content.
Example:Sample SVG content<svg><defs></defs><svg>YAML configdelete: "(?s)<defs>.*</defs>|\n"SVG content loaded into HTML will become:<svg></svg>CreditsI am not really a Python programmer, so I have borrowed plugin setup / utils /
inspiration from:https://github.com/stuebersystems/mkdocs-img2fig-pluginhttps://github.com/athackst/mkdocs-simple-pluginrajguru7I have cloned this fromhttps://gitlab.com/nicolas.dupont/mkdocs-plugin-inline-svg/-/tree/masterwhich is a fork ofhttps://gitlab.com/craig0990/mkdocs-plugin-inline-svgCredits to @craig0990 and @nicolar.dupont (GitLab) for the base plugin.
Package: mkdocs-plugin-progress
mkdocs-plugin-progressA plugin for MkDocs that lets you know exactly what is happening during the build.
This is helpful for use cases such as debugging, or trying to find out which pages the builder is getting stuck on for longer periods of time.UsagePlease seethe documentation.LicenseCopyright (c) 2020-current year Reece Dunham - under the Apache license, a copy of which can be found athttps://www.apache.org/licenses/LICENSE-2.0
Package: mkdocs-plugin-tags
TagsSupport for tags in the yaml-metadata in the header of markdown files.Extracts this metadata and creates a "Tags" page which lists all tags
and all pages for each tag.Quick DemoInstall this plugin (it will also install mkdocs if required)pipinstallmkdocs-plugin-tagsCreate a new documentation folder:mkdocsnewdemoEdit the.mdfiles to add initial metadata. Currently, the metadata has to be
enclosed in---lines, and must include atitle:property
(otherwise the page will appear as "untitled" in the tags page). So, for example:cddemocddocs
cat>index.md
---
title:Welcome
tags:-testing-unimportant
---# Welcome to MkDocsForfulldocumentationvisit[mkdocs.org](https://mkdocs.org).

^DEditmkdocs.ymlto include this plugin:plugins:-tags:Run the server:mkdocsserve--livereloadVisit the URL/tags(it should appear in the nav panel).
This is an auto-generated page which contains the tags as level 2 headers,
and under each tag, a listing of the pages which declare that tag in the
metadata section.How it worksOn each build (even with--livereload), all the.mdfiles composing the
site are scanned, their "triple-dash-delimted" yaml header is extracted and
parsed, and the list of tags is collected.After that, a new temporal file is created (by default inaux/tags.md, but
this is customizable) which contains the generated tags page, in markdown
format. This file is not in the documents folder to avoid retriggering a
build, but it is added to the list of files to be converted to HTML by mkdocs.CustomizationThe layout of the tags page is a markdown file with jinja2 embedded contents.
The package provides such a template by default, with the following content:---title: Tags---# Contents grouped by tag{% for tag, pages in tags %}## <span class="tag">{{tag}}</span>{%  for page in pages %}*[{{page.title}}]({{page.filename}})
{% endfor %}

{% endfor %}You can style theh2.tagelement via CSS, if you want.You can also provide your own markdown template, in case that you want a
different layout or metadata. Thepageobject contains all the metadata
in a mkdocs page, and in addition a.filenameattribute, which contains
the file name of the source of the page (relative to the docs folder),
which can be used to link to that page.The full customizable options for the plugin are:tags_folder: Folder in which the auxiliar tags markdown file will be written
(auxby default, relative to the folder in whichmkdocsis invoked).
It can be set to an absolute path, such as/tmp/mysite/aux.
The required folders are created.tags_template: path to the file which contains the markdown-jinja template
for the tags page. It isNoneby default, which means that the
package-provided template is used. It can be an absolute path,
or relative to the folder in whichmkdocsis run.css_name: this allows you to pick what name styles the tag that appears on
the top of the page that contains a tag. This way things won't be overloadedFor example, this can be put atmkdocs.yaml:plugins:-search-tags:tags_folder:/tmp/mysite/auxtags_template:docs/theme/tags.md.template
Package: mkdocs-pom-parser-plugin
mkdocs-pom-parser-pluginA simplemkdocsplugin which parsers apom.xmlfile and exposes it's values as template environment variables.
This is handy when the project which is being documented is using maven.NOTE: Does not support multiplepom.xmlfiles, but if you are interested - feel free to contribute.Installationpip install mkdocs-pom-parser-pluginUsageAdd the plugin into yourmkdocs.ymlplugins:
  - pom-parser-plugin:
      path: ../pom.xml (default, assumes this is a maven project )By default, the plugin will export all of the commonly used tags as template environment variables:pom.xmltemplate variableproject.modelVersionPOM_MODEL_VERSIONproject.groupIdPOM_GROUP_IDproject.artifactIdPOM_ARTIFACT_IDproject.packagingPOM_PACKAGINGproject.versionPOM_VERSIONproject.namePOM_NAMEproject.descriptionPOM_DESCRIPTIONproject.urlPOM_URLIn your.mdfiles you can reference these variables to generate adependency installationsection in your documentation:<dependency>
        <groupId>{{ POM_GROUP_ID }}</groupId>
        <artifactId>{{ POM_ARTIFACT_ID }}</artifactId>
        <version>{{ POM_VERSION }}</version>
    </dependency>If you need a field which is missing from the list above - you can add it via the configuration:plugins:
  - pom-parser-plugin:
      path: ../pom.xml
      additional:
        # template key: valid xpath filter
        # will become usable via {{ POM_SCM_CONNECTION }} in the template.
        SCM_CONNECTION: ./scm/connectionDevelopmentRun./build.shordocker-compose upand checklocalhost:8000Install locally1.pip install -e . && mkdocs build --config-file tests/resources/mkdocs.yml(still editable)orpip install ./.tox/dist/mkdocs*.tar.gz && mkdocs build --config-file tests/resources/mkdocs.ymlRelease./create-release.shto create a tag.Github Actions will do the rest.
Package: mkdocs-ponylang
Ponylang Mkdocs ThemeA customized theme based onhttps://github.com/squidfunk/mkdocs-materialfor
MkDocs of the Ponylang Standard Library documentation.UsageInstall the theme from PyPI:pipinstallmkdocs-ponylangIn yourmkdocs.ymlfile, change the theme:theme:name:ponylangCustomizationTable of contents# Enable permalinksmarkdown_extensions:-markdown.extensions.toc:permalink:true# Set maximum depththeme:max_toc_depth:2Palettetheme:palette:primary:brownaccent:amberYou can choose from primary and accent colors listedhere.Iconstheme:favicon:asserts/image/logo.pnglogo:icon:cloudLogos can be images or Material icons (more infohere).Source repositoryrepo_name:ponylang/ponycrepo_url:https://github.com/ponylang/ponycOther customizationsExtra customization options are available in theMaterial theme documentation.DevelopmentRequirementsPython 3npmlibpng-devInstallationThis will set up all of the necessary packages to install the theme locally.gitclonehttps://github.com/ponylang/mkdocs-themecdmkdocs-theme
python-mvenvvenvsourcevenv/bin/activate
pipinstall-e.
npminstallBuildCompile files fromsrc/with Webpack:npmrunbuildDistributionUpload to PyPI with Twine by calling the following Makefile targets:makeclean
makeupload-to-pypi
Package: mkdocs-preview-links-plugin
Fork of midnightprioriem/mkdocs-tooltipster-links-pluginmkdocs-tooltipster-links-pluginAn MkDocs plugin that adds tooltips to preview the content of page links using tooltipsterSetupInstall the PluginInstall the plugin using pip:pip install mkdocs-preview-links-pluginActivate the plugin inmkdocs.yml:plugins:-search-tooltipster-linksNote: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.Install TooltipsterPlease referenceTooltipster's getting started guidefor additional installation instructions.Download Tooltipster and add the css and javascript tomkdocs.yml:extra_css:
  - css/tooltipster.bundle.min.css

extra_javascript:
  - js/tooltipster.bundle.jsCreate custom directory andmain.htmlfile for overriding theextra_headtemplate blockmkdirtheme
touchtheme/main.htmlAdd the following tomain.html:{% extends "base.html" %}

{% block extrahead %}<scriptsrc="https://code.jquery.com/jquery-3.6.0.min.js"></script><script>$(document).ready(function(){$('.link-tooltip').tooltipster();});</script>{% endblock %}Add the custom directory tomkdocs.yml:theme:
  name: mkdocs
  custom_dir: themeAdd additonal css to the site (either in a new css file or existing one):.tooltipster-base{max-width:50%;}.tooltipster-contentimg.wikilink{max-width:10%;}.tooltip_templates{display:none;}UsageOnce configured property, tooltips-links should create tooltips automagically!The plugin is not compatible withnavigation.instantin Material Theme. For this theme, some styling are disponible in thedocs/material.cssfile.Custom configurationIn you config file to add compatibility for these plugins :mkdocs calloutsmkdocs custom tags attributesJust edit your config file and add the following:plugins:
  - search
  - tooltipster-links:
      callouts: true
      custom-attributes: 'assets/css/custom_attributes.css'Moreover, you can configure the max characters limits and the characters used after truncate (400 used by default):plugins:
  - search
  - tooltipster-links:
      max-characters: 400 #use 0 or 1 for no limit
      truncate-characters: '...'See AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-print-site-plugin
mkdocs-print-site-pluginMkDocsplugin that adds a print page to your site that combines the entire site, allowing for easy export to PDF and standalone HTML. Seedemo.Features :star2:Support formkdocs-materialtheme, including features like instant loading and dark color themes.Support for pagination in PDFs.Many options to customize appearanceOption to add a cover pageLightweight, no dependencies.SetupInstall the plugin usingpip3:pip3installmkdocs-print-site-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - print-site⚠️ Make sure to putprint-siteto thebottomof the plugin list. This is because other plugins might alter your site (like the navigation), and you want these changes included in the print page.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.UsageNavigate to/print_page/orprint_page.htmlExport to standalone HTML (seeexport to HTML)Export to PDF using your browser usingFile > Print > Save as PDF(seeexport to PDF)DocumentationAvailable attimvink.github.io/mkdocs-print-site-plugin.ContributingContributions are very welcome! Start by reading thecontribution guidelines.
Package: mkdocs-protobuf
Mkdocs Protobuf pluginSource Code:https://github.com/rymurr/mkdocs_protobufThis plugin inserts protobuf messages into template parameters in mkdocs websites. It can be
used to embed Protobuf IDL into documentation sites.UsageTo use in mkdocs install via pippip install mkdocs_protobuf.Add the following tomkdocs.ymlplugins:
 - mkdocs_protobuf:
     proto_dir: /path/to/proto/filesThe plugin will search for any templataes like the following:%%% proto.message.MessageName %%%and will replace the template with the protobuf messageMessageName. See thetestsdirectory
for an example. The escape characters are odd as to not interfere w/ Jinja2 templating from other plugins.DevelopmentSetup environementYou should havePipenvinstalled. Then, you can install the dependencies with:pipenvinstall--devAfter that, activate the virtual environment:pipenvshellRun unit testsYou can run all the tests with:maketestAlternatively, you can runpytestyourself:pytestFormat the codeExecute the following command to applyisortandblackformatting:makeformatLicenseThis project is licensed under the terms of the Apache Software License 2.0.
Package: mkdocs-publisher
date: 2023-10-02 23:12:38
update: 2023-10-10 13:18:32Publisher for MkDocsPublisher forMkDocsis a set of plugins that helps with content creation and publication.Featurespub-meta– support for:automaticdocument navigationcreation based on file names order,document publication status,possibility to define document and directories URL (good for SEO),document creation and update date (good for SEO),pub-blog– blogging capability:index creation,support for blog post teasers,automatic creation of pages for archive, categories and tags,pub-obsidian– bindings forObsidina.mdthat allows you to use:backlinks,callouts,wikilinks,vega charts(usingVega Visualization Plugin for Obsidian) - advanced solution for creating charts,pub-social– social cards for social media sharing using document metadata,pub-minifier– file size optimization (good for SEO and overall page size optimization),pub-debugger– logging on steroids with the possibility of creating of ZIP file with logs and additional information (can be used for better issue reporting).Installationpip install mkdocs-publisherMore information about installation methods and plugin setup can be found on thisdocumentation page.[!warning]
Before any use, make sure you have a backup of your data.[!note]
As a base for any development,mkdocs-materialtheme was used. If you are willing to use any other theme, you may (or may not) face some issues. If this happens, please submit anissue.After installation, you have to enable plugins and Material for MkDocs theme inmkdocs.ymlfile:theme:materialplugins:-search# Material for MkDocs search plugin-pub-debugger-pub-obsidian# blog is a directory with all blog posts-pub-obsidian-pub-social-pub-meta-pub-minifierPlanned featuresA full list of planned developments can be found onthis documentation page. I'm planning to move it to the projectGitHub issueswith proper badges and longer descriptions, but it's time-consuming and at this stage I'd rather spend it to develop a project.Version historyThe entire version history can be found in the projectversion historydocument and insidereleases.
Package: mkdocs-pug
mkdocs-pugThis MkDocs plugin is based onpypugjs.To install:pip install mkdocs_pugTo use, add this to yourmkdocs.yml:plugins:
  - mkdocs_pugThen, this plugin will watch for*.pugfiles in your template directories and build the corresponding*.htmlfiles in the same location.To do this automatically with the server during development, you should run withmkdocs serve --watch-themeThis repo contains an example of how to use this plugin inside an MkDocs project.