Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-diagrams
mkdocs-diagramsA plugin for theMkDocsdocumentation site generator which facilitates easy embedding of system architecture diagrams through theDiagramsproject (view examples).Installationmkdocs-diagramsis available on PyPI.
It can be installed throughpip install mkdocs-diagramsor equivalent command with pipenv or poetry.You'll also need to have thegraphvizdottool installed on your system.
It's available asgraphvizin most package managers.Once installed, configure MkDocs to use this plugin by includingdiagramsin thepluginslist in yourmkdocs.yml.
For example:plugins:-diagrams-search(If you don't have apluginskey in your config yet, you'll almost surely want to includesearchas well.
It's a default plugin that will otherwise get deactivated.)UsageWarning:This plugin will execute.diagram.pyfiles during build, as that is howDiagramsitself operates.
Be careful using this plugin with untrusted input as this effectively allows arbitrary code execution.Once installed, the diagrams plugin can be used by including diagrams files in your docs directory.For example, create a file namedexample.diagrams.pywith the following contents:fromdiagramsimportCluster,Diagramfromdiagrams.aws.computeimportECS,EKS,Lambdafromdiagrams.aws.databaseimportRedshiftfromdiagrams.aws.integrationimportSQSfromdiagrams.aws.storageimportS3withDiagram("Event Processing",show=False):source=EKS("k8s source")withCluster("Event Flows"):withCluster("Event Workers"):workers=[ECS("worker1"),ECS("worker2"),ECS("worker3")]queue=SQS("event queue")withCluster("Processing"):handlers=[Lambda("proc1"),Lambda("proc2"),Lambda("proc3")]store=S3("events store")dw=Redshift("analytics")source>>workers>>queue>>handlershandlers>>storehandlers>>dwWhen MkDocs is run (either withbuildorserve), this will result in a file namedevent_processing.pngbeing created.
Include this in your markdown files using regular image syntax:![Event processing architecture](event_processing.png)ConfigurationThis plugin supports a few config options, which can be set as follows:plugins:-diagrams:file_extension:".diagrams.py"max_workers:5file_extensionSets the filename extension for diagram files.
Whenmkdocs buildormkdocs serveis run, all files ending in this extension will be executed.Default:.diagrams.pymax_workersA pool of workers is used to render diagram files in parallel on multi-core systems.
Setting this allows you to limit the number of workers to this amount.Default: Dynamically chosen (os.cpu_count() + 2)
Package: mkdocs-dracula-theme
Dracula forMkdocsA dark theme forMkdocs.InstallInstallation MkDocsTo install MkDocs, run the following command from the command line:pipinstallmkdocsInstallation themeInstall the theme using PIP:pipinstallmkdocs-dracula-themeActivating themeAfter the theme is installed, edit yourmkdocs.ymlfile and set the theme name todracula:theme:
    name: draculaAll instructions can be found atdraculatheme.com/mkdocs.TeamThis theme is maintained by the following person(s) and a bunch ofawesome contributors.Fernando CelmerLautaro LinquimánCommunityTwitter- Best for getting updates about themes and new stuff.GitHub- Best for asking questions and discussing issues.Discord- Best for hanging out with the community.Getting HelpWe use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.🐛Bug Report📕Documentation Issue🚀Feature Request💬General QuestionCommit Style⚙️ FEATURE📝 PEP8📌 ISSUE🪲 BUG📘 DOCS📦 PyPI❤️️ TEST⬆️ CI/CD⚠️ SECURITYLicenseMIT License
Package: mkdocs-drawio
MkDocs Plugin for embedding Drawio filesBuy Sergey a 🍜Sergey (onixpro) is the original creator of this plugin. Repo can be foundhere.FeaturesThis plugin enables you to embed interactive drawio diagrams in your documentation. Simply add your files like you would any other image:![](my-diagram.drawio)Additionally this plugin supports multi page diagrams by using thealttext to select the pages by name:![Page-2](my-diagram.drawio)
![my-custom-page-name](my-diagram.drawio)SetupInstall plugin using pip:pip install mkdocs-drawioAdd the plugin to yourmkdocs.ymlplugins:-drawioConfigurationTo use a custom source for the drawio viewer JavaScript file you can overwritte the url.plugins:-drawio:viewer_js:"https://viewer.diagrams.net/js/viewer-static.min.js"How it worksAfter mkdocs has generated the html for your documentation, this plugin adds the necessary drawio javascript library. Searches forimgtags with a file ending of*.drawioand replaces them with the appropiatemxgraphhtml block. For further details, please have a look at theofficial drawio.com documentation.
Package: mkdocs-drawio-file
MkDocs Plugin for embedding Diagrams.net (Draw.io)Buy me a 🍜FeaturesThis plugin enables you to embed interactive drawio diagrams in your documentation. Simple add your files like you would for any other image type:![](my-diagram.drawio)Additionally this plugin supports multi page diagrams by using thealttext:![Page-2](my-diagram.drawio)SetupInstall plugin using pip:pip install mkdocs-drawio-fileAdd the plugin to yourmkdocs.ymlplugins:-drawio_fileHow it worksAfter your mkdocs has generated the HTML for your documentation, the plugin adds the necessary diagram.net javascript library. Searches forimgtags with a file ending of*.drawioand replaces them with the appropiatemxgraphhtml block. For further details, please look at theofficial diagrams.net documentation.
Package: mkdocs-edupress-theme
mkdocs-edupress-themeEdupress theme for mkdocs.Recommend installing mkdocs-paginate-plugin for best results.Example from this project:https://kubilus1.github.io/mkdocs-edupress-theme/LayoutThis is intended for a typical blog style layout.  A top level 'index.md' is
expected, but basically ignored.  Posts can be in a subdir or in the top level
directory.  All files will be collected and treated as posts.ExtrasThis theme supports a few special yaml config items in your posts such as:index: <int>This allows you to control the layout of posts.  These will be sorted in
reverse order.  As you add new posts you can expect the greatest number/newest
to be first.featured_image: <path>Adds a featured image to a post.  This should be relative to the top level of
the site_url.  Leave off any beginning/tags: [<list of tags>]Adds lists of tags on the homepage for each post.  This may be used at a later
point to show pages of matching tags.author: <name>Show the post's author.  This may be used in the future to provide a page of
matching articles.date: <date>Show the date of a post.
Package: mkdocs-embed-file-plugins
Embed FileA way to embed a file present in your docs.
Support both wikilinks & normal links.
Intended to be used by obsidian user.Activate the pluginRunpip install mkdocs-embed-file-pluginsUpdate yourmkdocs.ymlwith :plugins:-search-embed_fileOverrideyourmain.htmlwith :{% extends "base.html" %}
{% block extrahead %}<linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5.15.4/css/fontawesome.min.css"integrity="sha384-jLKHWM3JRmfMU0A5x5AkjWkw/EYfGUAGagvnfryNV3F9VqM98XiIH7VBGVoxVSc7"crossorigin="anonymous">{% endblock %}[!IMPORTANT]
You need to set thesite_urlin themkdocs.ymlto make the plugin work.UsageUsagewikilinksmarkdown linkscite a entire file![[filename]]![](filename)Cite a heading part![[filename#heading]]![](filename#heading)Cite a block![[filename#^blockid]]![](filename#^blockid)CSSThe plugin will create :A link to the original file, with the form of :<a href="original link" class="link_citation"><i class='fas fa-link'></i></a>A div with the founded content :<div class="citation">content founded</div>In case of the link / contents is not found the following block is created instead :<divclass='citation'><aclass='link_citation'><iclass='fas fa-link'></i></a><pstyle="text-align: center; display: block"><iclass="not_found">link_alt</i>{a configured message}</p></div>The message for the not found file can be customized inmkdocs.yml. The default message isfile not exists.You can add a css in yourdocs/assets/css(or whatever the path is), and add it to yourmkdocs.yml:extra_css:
    - assets/css/embed_link.cssYou can find an example of custom css indocsConfigurationIf you want, you can add compatibility with :mkdocs calloutsmkdocs custom tags attributesTo do that, adjust yourmkdocs.ymlmarkdown_extensions:-attr_list-nl2br-admonition-pymdownx.detailsplugins:-search-callouts-custom-attributes:file:'assets/css/custom_attributes.css'-embed_file:callouts:truecustom-attribute:'assets/css/custom_attributes.css'//need to be the same as in the config!language_message:'filenotexists.'Note : Every extension set inmarkdown_extensionswill be used for the converting, so you can use any extension you want.LimitationThe embed file don't use plugin you would use.Wikilinks ambiguity are not supported : the first file with the name are used.CreditThanks tomidnightprioriemfor the tooltip plugin.
Package: mkdocs-embed-markdown
MkDocs Embed Markdown PluginAboutFork fromMkDocs Embed External Markdown Pluginand fix the conflict with mkdocs-macros plugin and support access of Gitea private repo by token. The basic functionality is the same as the original plugin. But when rendering markdown, it search the opening tag (@include) in the whole text and replace it with the content of the included file.InstallationInstall the package with pip:pipinstallmkdocs-embed-markdownConfigurationEnable the plugin in yourmkdocs.ymlfile:plugins:-external-markdownCompatibility with Github/Gitea Private RepositoryIf the GH_TOKEN environment variable is set with an authorized personal access token then the authorization header will be added to the request and content from private repositories can be fetched.For Gitea users, the GT_TOKEN environment variable can be used instead. You may need to go to profile > settings > applications > Manage Access Tokens, and add your token to the environment variable. The key is GT_TOKEN, and the value is your token.UsageSection defined by"##/###/####..."header (h2/h3/h4...)"#"header (h1) will beremovedfrom source content so you can use use your own header"##/###/####..."header (h2/h3/h4...) will beremovedfrom sourcesectioncontent so you can use use your own headerSupports multiplesectionsfrom any source@includerequires 2 parameters:urlandsection name.@include('url', '## section name')Full Markdown ContentEmbed full markdown content from a given url, you can use the following example:@include('https://raw.githubusercontent.com/fire1ce/DDNS-Cloudflare-Bash/main/README.md', '')Specific SectionEmbed markdown section from a given url, you can use the following example:@include('https://raw.githubusercontent.com/fire1ce/DDNS-Cloudflare-Bash/main/README.md', '## Installation')MkDocs ExampleThe following example shows how to use the plugin in mkdocs project:# Example PageThis is an example page.## Embedding Multiple Markdown Sections From Different URLs### First Embedded Section```markdown@include('https://raw.githubusercontent.com/mkdocs/mkdocs/master/README.md', '## Features')```### Second Embedded Section```markdown@include('https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/README.md', '## Quick start')```Will produce the following page:Known Issues[ ]ChangelogSeehttps://github.com/fire1ce/mkdocs-embed-external-markdown#changelogLicenseThis project is licensed under the terms of theMIT License.
Package: mkdocs-em-img2fig-plugin
MkDocs Em-Img2Fig PluginThisMkDocsplugin converts markdown encoded images surrounded by two asterisks or two underscores like*![An image caption](\assets\images\my-image.png)*OR_![An image caption](\assets\images\my-image.png)_into<figure>notation with inline markdown for the image itself:<figuremarkdown>![Image caption](\assets\images\my-image.png)<figcaption>Image caption</figcaption></figure>CreditsThis plugin is a fork of thehttps://github.com/stuebersystems/mkdocs-img2fig-pluginwhich does not require the two asterisks or two underscoresRequirementsThis package requires:Python >=3.9 and MkDocs version 1.0 or higher.md_in_htmlextension enabled in your MkDocs configuration.InstallationInstall the package with pip:pip install mkdocs-em-img2fig-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-autolinks-em-img2figNote:If you use autolinks or similar plugin declare em-img2fig after it, not before for correct precedence.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.More information about plugins in theMkDocs documentation
Package: mkdocs-encriptmail-plugin
MkDocs encriptMail PluginThisMkDocsplugin converts markdown encoded email addresses like[Email-Link](mailto:test@test.test)into<ahref="javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)">Email-Link</a>or[test@test.test](mailto:test@test.test)into<ahref="javascript:linkTo_UnCryptMailto(%27ocknvq,vguvBvguv0vguv%27)">test(Q)test(P)test</a>This allows to hide email address from spam bots and allows user to link email addresses.RequirementsThis package requires Python >=3.5 and MkDocs version 1.0 or higher.InstallationInstall the package with pip:pip install mkdocs-encriptmail-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-encriptmail:placeholderAt:(Q)placeholderDot:(P)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.More information about plugins in theMkDocs documentation
Package: mkdocs-encryptcontent-plugin-gw
mkdocs-encryptcontent-pluginThis plugin allows you to have password protected articles and pages in MKdocs. The content is encrypted with AES-256 in Python using PyCryptodome, and decrypted in the browser with Crypto-JS. It has been tested in Python 2.7 and Python 3.5+An mkdocs version of the pluginEncrypt contentfor Pelican.usecaseI want to be able to protect my articles with password. And I would like this protection to be as granular as possible.
It is possible to define a password to protect each article independently or a global password to encrypt all of them.
If a global password exists, all articles and pages except the homepage are encrypted with this password.
If a password is defined in an article or a page, it is always used even if a global password exists.
If a password is defined as an empty character string, the page is not encrypted.InstallationInstall the package with pip:pipinstallmkdocs-encryptcontent-pluginInstall the package from source with pip:cdmkdocs-encryptcontent-plugin/
python3setup.pysdistbdist_wheel
pip3installdist/mkdocs_encryptcontent_plugin-0.0.3-py3-none-any.whlEnable the plugin in yourmkdocs.yml:plugins:-search-encryptcontent:{}You are then able to use the meta tagpassword: secret_passwordin your markdown files to protect them.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.Using global password protectionAddglobal_password: your_passwordin plugin config variable, to protect by default your articles with this passwordplugins:-search-encryptcontent:global_password:'your_password'If a password is defined in an article, it will ALWAYS overwrite the global password.NOTEKeep in mind that if thepassword:tag exists without value in an article, it will not be protected !Extra vars customizationOptionally you can addtitle_prefixandsummaryin plugin config variables to customize default messages.plugins:-search-encryptcontent:global_password:'your_password'title_prefix:'[LOCK]'summary:'anotherinformationalmessagethanthedefaultone'Default prefix title is[Protected]and default summary message isThis content is protected with AES encryption.NOTEAdding a prefix to the title does not change the default navigation path !FeaturesHighlightJS supportIf your theme use HighlightJS module to improve color, andhighlightjs: trueis set in yourmkdocs.yml, this plugin enable this part of the jinja template to force reload heiglighting in decrypted content.{%ifhljs%}document.getElementById("mkdocs-decrypted-content").querySelectorAll('pre code').forEach((block) => {hljs.highlightBlock(block);});{%endif%}ContributingFrom reporting a bug to submitting a pull request: every contribution is appreciated and welcome.
Report bugs, ask questions and request features usingGithub issues.
If you want to contribute to the code of this project, please read theContribution Guidelines.Contributorsanthonyeden
Package: mkdocs-entangled-plugin
Welcome to MkDocs Entangled PluginUsing this plugin, you can make your Entangled documents look better.ExamplesDetailed examples are found in theentangled/mkdocs-examples repository.InstallInstall this withpip install mkdocs-entangled-plugin. To use the entangled plugin, add the following lines to yourmkdocs.yml:plugins:-entangledmarkdown_extensions:-pymdownx.superfences-pymdownx.tabbed:alternate_style:trueFor more information, seethe documentation.ComponentsThis plugin bundles functionality for literate programming with Entangled.Annotate code blocks with titles.Build artifacts using Make.Annotate code blocksThe default markdown syntax that Entangled supports has fenced code blocks as follows``` {.python file=examples/hello_world.py}
if__name__== "__main__":
    <<hello-world>>
```Which renders like this:if __name__ == "__main__":
    <<hello-world>>Or named code blocks``` {.python#hello-world}
print("Hello, World!")
```that render like this:print("Hello, Universe!")Build ArtifactsBuild artifacts by specifying a Makefile.=== "Figure 1"

    ![](fig/plot.svg)

=== "Source"

    ``` {.gnuplot file=examples/plot.gp}
    # enter your plotting commands here`````` {.make .build-artifact}.RECIPEPREFIX = >docs/fig/plot.svg: examples/plot.gp> mkdir -p $(@D)> gnuplot $^ > $@```=== "Figure 1"![](fig/plot.svg)=== "Source"``` {.gnuplot file=examples/plot.gp}
set term svg background rgb 'white' size 700, 500
sinc(r) = sin(pi*r) / (pi*r)
set isosamples 50, 50
set hidden3d
set xrange [-4:4]
set yrange [-4:4]
set xyplane 0
set title "Sinc function"
splot sinc(sqrt(x**2 + y**2)) t'' lc rgb '#5533cc'
```

``` {.make .build-artifact}
.RECIPEPREFIX = >

docs/fig/plot.svg: examples/plot.gp
> mkdir -p $(@D)
> gnuplot $^ > $@
```LicenseLicensed under the Apache-2 license agreement: see LICENSE
Package: mkdocs-exclude
File exclude plugin for mkdocsmkdocs-excludeis amkdocs pluginthat allows you
to exclude 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-excludeIn your project, add a plugin configuration tomkdocs.yml:plugins:-exclude:glob:-exclude/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-excluder-plugin
File exclude plugin for mkdocsExtension ofmkdocs-excludeplugin to also provide
navigation filtering.mkdocs-excluder-pluginis amkdocs pluginthat allows you
to exclude 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:pip install mkdocs-excluder-pluginIn your project, add a plugin configuration tomkdocs.yml:plugins:-excluder:glob:-exclude/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-exclude-search
mkdocs-exclude-searchA mkdocs plugin that lets you exclude selected files or sections from the search index.If you only need to exclude a few pages or sections, mkdocs-material now introducedbuilt-in search exclusion!
Themkdocs-exclude-searchplugincomplementsthis with more configuration options (wildcard exclusions, ignoring excluded subsections). It also provides
search-exclusion functionality to regular mkdocs users.SetupInstall the plugin using pip:pipinstallmkdocs-exclude-searchActivate thesearchandexclude-searchplugins inmkdocs.yml.searchis required, otherwiseexclude-searchhas no effect!plugins:-search-exclude-searchMore information about plugins in theMkDocs documentation.ConfigurationList the markdown files to be excluded underexcludeusing the format<path>/<to>/filename.mdin the docs folder.Exclude specific heading subsections using the format<path>/<to>/filename.md#some-heading. Chapter names are all lowercase,-as separator, no spaces.Exclude all markdown files within a directory (and its children) withdirname/*.Exclude all markdown files with a specific name within all subdirectories withdirname/*/filename.mdor/*/filename.md.To still include a subsection of an excluded file, list the subsection heading underignoreusing the format<path>/<to>/filename.md#some-heading.To exclude all unreferenced files (markdown files not listed in mkdocs.yml nav section), useexclude_unreferenced: true. Default false.plugins:-search-exclude-search:exclude:-first.md-dir/second.md-third.md#some-heading-dir2/*-/*/fifth.mdignore:-dir/second.md#some-headingexclude_unreferenced:truenav:-Home:index.md-First chapter:first.md-Second chapter:dir/second.md-Third chapter:third.md-Fourth chapter:dir2/fourth.md-Fifth chapter:subdir/fifth.mdThis example would exclude:the first chapter.the second chapter (but still include itssome-headingsection).thesome-headingsection of the third chapter.all markdown files withindir2(and its children directories).all markdown files namedfifth.mdwithin all subdirectories.all unreferenced filesSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-exclude-tagged-files
MKDocs Exclude Tagged FilesA simple plugin for excluding files from being included in the mkdocs output based on tags in their frontmatter.InstallationRunpip install --upgrade mkdocs-exclude-tagged-filesConfigurationBasic Configuration in themkdocs.ymlfile:plugins:-mkdocs_exclude_tagged_files:tags_to_exclude:["confidential","excluded"]This configuration will exclude all files that have one of the tags "confidential" or "excluded" in their frontmatter.For example this file will be excluded:---tags: ["confidential", "someothertag"]---# ContentBy default, the plugin strips leading#-symbols from tags, so the tag#excludedwill be treated the same asexcluded.If you want to disable this behavior set the config valuestrip_leading_hashtagstofalse.