Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-markmap
mkdocs-markmapBeautiful and simple mindmaps written in markdown.This is a plugin and an extension formkdocsto addmarkmap.PrerequisitsThis plugin was tested with, but is not limited to:Python 3.9mkdocs 1.3QuickstartInstallpipinstallmkdocs-markmapConfigureAdd this tomkdocs.yml:plugins:-markmapUsageThis plugin supports code blocks of markdown as follows:```markmap# Root## Branch 1* Branchlet 1a* Branchlet 1b## Branch 2* Branchlet 2a* Branchlet 2b```It can also make use of file includes to keep your markdown tidy:Look at this beautiful mindmap:

{!mindmap.mm.md!}Advanced SettingsThere are more options available formkdocs.yml(shown values are defaults):plugins:-markmap:base_path:docsencoding:utf-8file_extension:.mm.mdd3_version:7lib_version:0.15.3view_version:0.15.3In addition, feel free to define your favourite source urls like this:plugins:-markmap:# disable the default assets firstd3_version:''lib_version:''view_version:''extra_javascript:-https://unpkg.com/d3@7/dist/d3.min.js-https://unpkg.com/markmap-lib@0.15.3/dist/browser/index.js-https://unpkg.com/markmap-view@0.15.3/dist/browser/index.jsTroubleshootingNav tree lists markmapsMove your markmap files to a separate folder next todocs, e.g.mindmapsConfigurebase_pathaccordingly (seeAdvanced Settings)Static javascript files not workingEnsure naming of javascript files matches the scheme (seeAdvanced Settings)Copy all javascript files todoc/js/, otherwisemkdocswill not copy static files tosite/Define all files inextra_javascript, e.g.extra_javascript:-js/markmap-d3.js-js/markmap-lib.js-js/markmap-view.jsUsage of proxy is preventing download of javascript filesUsually proxies should be supported byrequests, which is used for downloading all required javascript files. If the issue remains, try downloading the files yourself and store them accordingly (seeStatic javascript files not working)Credits :clap:Some of the development approaches are based on implementations provided by the following projects:markmap(key feature of this project)markdown-include(basis for extension support)mkdocs-mermaid2-plugin(basis for plugin support)
Package: mkdocs-material-adr
ADR for MkDocs's Material ThemeADRare short text documents that captures an important architectural decision made along with its context and consequences.DemoInstallpipinstallmkdocs-material-adr# orpoetryaddmkdocs-material-adrIn themkdocs.ymlfiletheme:# set the namename:mkdocs-material-adr# Configuration for the material themefeatures:-navigation.instantplugins:-mkdocs-material-adr/adrFeaturesADR HeadersInformation about the ADR are displayed in a header
Define information about the ADR in the frontmatter.---
    title: 0004 Title
    adr:
        author: Jean-Loup Monnier
        created: 01-Aug-2023
        status:  draft | proposed | rejected | accepted | superseded
        superseded_by: 0001-test
        extends:-0001-first- 0002-second---You can change the colors or add new status using css/* Background color */.c-pill-<lower_case_status_name>{background:#a3a3a3;}/* Dot color */.c-pill-<lower_case_status_name>:before{background:#505050;}ADR GraphAuto generated graph.
To enable it add[GRAPH]in the markdown file you want the graph to be, Then add th following configurationplugins:-mkdocs-material-adr/adr:graph_file:index.md# Change this to your filemarkdown_extensions:-pymdownx.superfences:custom_fences:-name:mermaidclass:mermaidformat:!!python/name:pymdownx.superfences.fence_code_format
Package: mkdocs-material-igwn
IGWN Material for MkDocsThis project defines the IGWN Material theme for MkDocs, an extension ofMaterial for MkDocs.To install this package:python-mpipinstallmkdocs-material-igwnTo use the theme add the following to yourmkdocs.yml:theme:name:material_igwnFor full details, seehttps://computing.docs.ligo.org/igwn-material/mkdocs/.
Package: mkdocs-material-relative-language-selector
mkdocs-material-relative-language-selectorEdit the builtinmkdocs-material site selectorto
make the links between languages relative.If you have in Github Pages the URLhttps://foo.github.io/bar/es/config/,
you can access it from the URLhttps://foo.github.io/bar/config/selecting
Spanish in the language selector.The current language being displayed will be removed from the language
selector, so you will only capable to access to other languages than the
current.Installationpip install mkdocs-material-relative-language-selectorExample configurationWithmkdocs-mdpo-plugintheme:name:materiallanguage:enplugins:-search-material-relative-language-selector-mdpoextra:alternate:-name:Englishlang:en-name:Españollink:eslang:esConfigurationIf you want to publish your site in Github Pages, you don't need to define any
setting because is the default configuration.If you want to serve your site
under a custom root domain, defineroot_domain: trueto get correct links
between languages.Projects using itmkdocs-mdpo-plugin
Package: mkdocs-matplotlib
Mkdocs-MatplotlibMkdocs-Matplotlibis a plugin formkdocswhich allows you to automatically generate matplotlib figures and add them to your documentation.
Simply write the code as markdown into your documention.Quick StartThis plugin can be installed withpippipinstallmkdocs-matplotlibTo enable this plugin for mkdocs you need to add the following lines to yourmkdocs.yml.plugins:-mkdocs_matplotlibTo render a code cell using matplotlib you simply have to add the comment# mkdocs: renderat the top of the cell.# mkdocs: renderimportmatplotlib.pyplotaspltimportnumpyasnpxpoints=np.array([1,8])ypoints=np.array([3,10])plt.plot(xpoints,ypoints)In addition you can add the comment# mkdocs: hidecodeto hide  the code and and# mkdocs: hideoutputto hide the output image of the cell.
Package: mkdocs-mdpo-plugin
mkdocs-mdpo-pluginTranslations for Mkdocs using PO files, fully customizable.
Compatible withmkdocs-material,
based onmdpo.Documentation:en-esInstallpip install mkdocs-mdpo-pluginUsageEnable the plugin in yourmkdocs.yml:plugins:-mdpoMinimal configurationWithmkdocs-materialtheme:name:materiallanguage:enextra:alternate:-name:Englishlang:en-name:Españollink:eslang:esplugins:-mdpoStandaloneplugins:-mdpo:languages:-en# first language is the original-esBoth previous configurations will create the same layout of files building the
documentation. Given the next layout in adocs/directory:📁 docs
└── 📄 index.mdAfter the build, you will get:📁 docs
├── 📁 es
│   └── 📄 index.md.po
└── 📄 index.mdJust translate the strings indocs/es/index.md.pointo Spanish, build again
withmkdocs buildand thesite/directory will look like:📁 site
├── 📄 404.html
├── 📁 assets
│   ├── 📁 images
│   ├── 📁 javascripts
│   └── 📁 stylesheets
├── 📁 es
│   └── 📄 index.html
├── 📄 index.html
├── 📄 sitemap.xml
└── 📄 sitemap.xml.gzSimple and easy. The extraction of messages process and the produced
layout are fully customizable, you can even translate code blocks!Check the full documentation here.
Package: mkdocs-merge
MkDocs MergeThis simple tool allows you to merge the source of multipleMkDocssites
into a single one converting each of the specified sites to a sub-site of the master site.Supports unification of sites with the samesite_nameinto a single sub-site.ChangelogAccess the changelog here:https://ovasquez.github.io/mkdocs-merge/changelog/Note: Since version 0.6 MkDocs Merge added support for MkDocs 1.0 and dropped
support for earlier versions.
See here for more details about the changes inMkDocs 1.0.MkDocs-Merge officially supports Python versions 3.8, 3.9 and 3.10. It has been tested to work correctly in previous 3.X versions, but those are no longer officially supported.Install$pipinstallmkdocs-mergeUsage$mkdocs-mergerunMASTER_SITESITES[-u]...ParametersMASTER_SITE: the path to the MkDocs site where the basemkdocs.ymlfile resides. This is where all other sites
will be merged into.SITES: the paths to each of the MkDocs sites that will be merged. Each of these paths is expected to have amkdocs.ymlfile and adocsfolder.-u(optional): Unify sites with the same "site_name" into a single sub-site.Example$mkdocs-mergerunroot/mypath/mysite/another/path/new-site/newpath/websiteA single MkDocs site will be created inroot/mypath/mysite, and the sites in/another/path/new-siteand/newpath/websitewill be added as sub-pages.Originalroot/mypath/mysite/mkdocs.yml...nav:-Home:index.md-About:about.mdMergedroot/mypath/mysite/mkdocs.yml...nav:-Home:index.md-About:about.md-new-site:new-site/home/another.md# Page merged from /another/path/new-site-website:website/index.md# Page merged from /newpath/websiteDevelopmentDev InstallClone the repository and specify thedevdependencies on the install command.Check thisStackOverflow answerfor more details about thedevdependencies$pipinstall-e.[dev]TestThe tests can be run usingtoxfrom the root directory.toxis part of the development dependencies:$toxProject StatusVery basic implementation. The code works but doesn't allow to specify options for the merging.Pending workRefactoring of large functions.GitHub Actions build.Publish pip package.Better error handling.Merge configuration via CLI options.Unit testing (work in progress).CLI integration testing.Consider more complex cases.Make MkDocs Merge module friendly: thanks tomihaipopescu
Package: mkdocs-meta-manager
mkdocs-meta-managerMkDocs plugin for managing meta tags across folders and filesSetupInstall the plugin:pipinstallmkdocs-meta-managerAdd the plugin to yourmkdocs.ymlplugins:-search-meta-managerUsageAdd meta files with the name.meta.yml(can be configured) in your docs file structure.All markdown files in the same folder and in subfolders automatically get all tags that are defined in the given meta file.Optionsmeta_filenameChange the default name of the meta file. (default=.meta.yml)merge_tagsMerge the tags of all relevant meta files and pages for a page (default=false)
Package: mkdocs-minecraft
mkdocs-minecraftThis is a template for a MkDocs plugin.SetupInstall the plugin using pip:pip install mkdocs-minecraftActivate the plugin inmkdocs.yml:plugins:-search-minecraftNote: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.Configparam- This does somethingUsageSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-minify-html-plugin
mkdocs-minify-html-pluginMkDocs plugin for minification usingminify-html, an extremely fast and smart HTML + JS + CSS minifier.UsageInstall:python-mpipinstall-Umkdocs-minify-html-pluginActivate inmkdocs.yml:plugins:-search-minify_htmlOptionsA description of all options is available in theminify_html docs.The default plugin options are aimed at the best possible minification while maintaining compliance with the specification:plugins:-search-minify_html:do_not_minify_doctype:trueensure_spec_compliant_unquoted_attribute_values:truekeep_closing_tags:falsekeep_html_and_head_opening_tags:falsekeep_spaces_between_attributes:truekeep_comments:falsekeep_input_type_text_attr:truekeep_ssi_comments:falsepreserve_brace_template_syntax:falsepreserve_chevron_percent_template_syntax:falseminify_css:trueminify_js:trueremove_bangs:falseremove_processing_instructions:falseLicenseMIT
Package: mkdocs-minify-plugin
mkdocs-minify-pluginAn MkDocs plugin to minify HTML, JS or CSS files prior to being written to disk.HTML minification is done usinghtmlmin2.JS minification is done usingjsmin.CSS minification is done usingcsscompressor.SetupInstall the plugin using pip:pipinstallmkdocs-minify-pluginActivate the plugin inmkdocs.yml:plugins:-search-minify:minify_html:trueminify_js:trueminify_css:truehtmlmin_opts:remove_comments:truecache_safe:truejs_files:-my/javascript/dir/file1.js-my/javascript/dir/file2.jscss_files:-my/css/dir/file1.css-my/css/dir/file2.cssNote: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.Optionsminify_html:Defaults toFalse.Sets whether HTML files should be minified.minify_js:Defaults toFalse.Sets whether JS files should be minified.If set toTrue, you must specify the JS to be minified files usingjs_files(see below).minify_css:Defaults toFalse.Sets whether CSS files should be minified.If set toTrue, you must specify the CSS to be minified files usingcss_files(see below).htmlmin_opts:Defaults toNone.Sets runtime htmlmin API options using theconfig parameters of htmlmincache_safe:Defaults toFalse.Sets whether a hash should be added to the JS and CSS file names. This ensures that the browser always loads the latest version of the files instead of loading them from the cache.If set toTrue, you must specify the files usingjs_filesorcss_files(see below).js_files:Defaults toNone.List of JS files to be minified.The plugin will generate minified versions of these files and save them as.min.jsin the output directory.css_files:Defaults toNone.List of CSS files to be minified.The plugin will generate minified versions of these files and save them as.min.cssin the output directory.Note:When usingminify_jsorminify_css, you don't have to modify theextra_javascriptorextra_cssentries
in yourmkdocs.ymlfile. The plugins automatically takes care of that.
Bothminify_jsandminify_csssupport the use ofglobs(e.g.**/*.css).
Package: mkdocs-mk2pdf-plugin
MkDocs PDF Export PluginThe plugin is based onhttps://github.com/zhaoterryy/mkdocs-pdf-export-plugin/,the main change is use rst2pdf to convert doc to PDFs which support PDF navigation, another change is add a download icon on the pageAn MkDocs plugin to export content pages as PDF filesThe pdf-export plugin will export all markdown pages in your MkDocs repository as PDF files using pandoc and rst2pdf. The exported documents support many advanced features missing in most other PDF exports, such as PDF navigation.RequirementsThis package requires MkDocs version 1.0 or higher (0.17 works as well)Python 3.4 or higherpandoc, xelatex(to support Chinese)sudo apt install pandoc
sudo apt install texlive texlive-latex-extra texlive-latex-recommended texlive-xetexInstallationInstall the package with pip:pipinstallmkdocs-pdf-export-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-mk2pdf-exportNote: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 the [MkDocs documentation][mkdocs-plugins].TestingWhen building your repository withmkdocs build, you should now see the following message at the end of your build output:Converting 17 files to PDF took 15.6sIn yoursite_diryou should now have a PDF file for every markdown page.OptionsYou may customize the plugin by passing options inmkdocs.yml:plugins:-mk2pdf-export:enabled_if_env:ENABLE_PDF_EXPORTenabled_if_envSetting this option will enable the build only if there is an environment variable set to 1. This is useful to disable building the PDF files during development, since it can take a long time to export all files. Default is not set.combinedSetting this totruewill combine all pages into a single PDF file. All download links will point to this file. Default isfalse.combined_output_pathThis option allows you to use a different destination for the combined PDF file. Has no effect whencombinedis set tofalse. Default ispdf/combined.pdf.pandoc_templateThis option allows you to use a custom pandoc template to convert markdown file to pdf files.mkdocs.yml:plugins:-mk2pdf-export:project-root
├──docs
├──mkdocs.yml
├──site
.
.ContributingFrom reporting a bug to submitting a pull request: every contribution is appreciated and welcome. Report bugs, ask questions and request features using [Github issues][github-issues].
If you want to contribute to the code of this project, please read the [Contribution Guidelines][contributing].Special thanksSpecial thanks go to [Lukas Geiter][lukasgeiter] for developing the [mkdocs-awesome-pages-plugin][awesome-pages-plugin] which was used as a base and for convincing [Stephan Hauser][shauser] to write a plugin for this.
Package: mkdocs-mknodes
defcreate_github_index_md()->mk.MkPage:page=mk.MkPage("Github index")page+=mk.MkCode.for_object(create_github_index_md)page+=mk.MkHeader("MkNodes",level=1)page+=mk.MkHeader("Don't write docs. Code them.",level=4)page+=mk.MkShields()page+=mk.MkLink(DOC_URL,"Read the completely coded documentation!")page+=mk.MkInstallGuide(header="How to install")page+=mk.MkHeader("All the nodes!")page+=mk.MkClassDiagram(mk.MkNode,mode="subclasses",direction="LR")returnpageMkNodes (Mkdocs Plugin)Don't write docs. Code them.Read the completely coded documentation!How to installpipThe latest released version is available at thePython package index.pipinstallmkdocs-mknodes
Package: mkdocs-mktemplate-plugin
mktemplateThis is a plugin formkdocsto render jinja
templates in markdown documents.UsageTemplate files must be intemplates/in the root directory of your
mkdocs project.An example template file might look like this:<ul>{% for item in items %}<li>{{ item }}</li>{% endfor %}</ul>Then in any of the pages of your mkdocs project use the following syntax
to include a template and provide the variables.{%
template "template.html" # filename of the template in templates/ directory
items:-item 1-item 2-item 3
%}This will generate the following result:<ul><li>item 1</li><li>item 2</li><li>item 3</li></ul>Packages usedmkdocsJinjaPyYAML
Package: mkdocs-modify-base-url
mkdocs-modify-base-urlThis mkdocs plugin is meant to be used with:mkdocs-materialmikefor multiple versions of your documentationmulti-language documentationThe code in mkdocs-material that renders the version selection dropdown in the header dynamically requestsversions.jsonrelative to the page'sbase_url. This works well normally, but when you try to add multiple
languages, things start to get a bit tricky.I've set up my project documentation inside my repo like this:.
├─ config/
│    ├─ en/
│    │  └─ mkdocs.yml
│    ├─ nl/
│    │  └─ mkdocs.yml
│    ├─ .../
│
├─ content/
│    ├─ en/
│    │   ├─ index.md 
│    │   └─ ...
│    └─ nl/
│        ├─ index.md 
│        └─ ,,,
│
├─ generated/
│    ├─ branch
│    │  ├─ en/
│    │  └─ nl/
│    └─ index.html
│
└─ ...Each language has its ownmkdocs.yml. Each is configured like this (only showing relevant parts, usingenas
an example):docs_dir:'../../content/en'site_dir:'../../generated/branch/en'theme:language:enextra:version:provider:mikealternate:-name:Englishlink:enlang:enplugins:-modify-base-url:prefix:'../'All languages are individually generated intodocs/generated/branch/$LANGUAGEThere is a separatemkdocs.ymlformiketo support versioning. There is really only one key, required setting, that
tellsmiketo use what we previously generated:docs_dir:generated/branchWhen you runmike deploy VERSIONfrom within thedocsdirectory, it combines all the generated documentation for
all the languages into a single version. There is also a staticindex.htmlfile indocs/generated/branchthat
redirects initial requests to a default language.Given a URL such asdocs.kcp.io/kcp/main/en, when visitingindex.html, itsbase_urlis normally.because we
toldmkdocsto generate directly into theendirectory. What's unique about this situation is thatmkdocsthinks that one level up fromenshould be whereversions.jsonlives. But it's actually up one more level, atdocs.kcp.io/kcp/versions.jsonbecause of our configuration.And this is why this plugin exists. We need to adjust thebase_urlto move it up one more level, so instead of it
being.fordocs.kcp.io/kcp/main/en/index.html, it's actually... Now, whenmkdocs-materialrequestsbase_url/../versions.json, that becomes../../versions.json, which is reallydocs.kcp.io/kcp/versions.json.
Package: mkdocs-nature
AMkDocstheme. A clone of the “greenish” Sphinx theme of the same name.For a demonstration of itsfeaturessee thedocumentation.InstallationTo install the MkDocs-Nature them, run the following command:pip install mkdocs-natureSetupConfigure your MkDocs project to use the theme by setting thetheme.nametonature:theme:
    name: natureFor a list of supported variables which can be set in the config, see the
documentedfeatures.
Package: mkdocs-nav-enhancements
MkDocs Nav EnhancementsThis is a small plugin for the excellentMkDocsproject which makes some enhancements to the navigation.FeaturesEnhanced titlesBy default, MkDocs looks for a level 1 atx-style header found at the top of the document and uses that for the page title.If you are dealing with documentation from third-party sources you may find that some of them start their titles at level 2 (possibly for aesthetic reasons), or use setext-style headers instead.This plugin will try to help by looking through each Markdown document and using the following rules to detect a page title instead:Use the first atx-style header found in the document at any level between 1 to 6, which is any line beginning with between 1 to 6 '#' characters.Or use the first setext-style header, which is any line where the line immediately after contains only '=' or '-' characters, effectively 'underlining' the line.It will also remove any additional markup that is found in the title, such as image or link tags, which would otherwise be rendered as string literals in the generated HTML.Reduced foldersIn order to de-clutter the navigation, the plugin looks for any sections containing only one page, and tries to collapse that page up a level into its parent. This helps deal with navigation bars filled with single-page folders to keep things looking tidy.UsageInstall the plugin:pipinstallmkdocs-nav-enhancementsAdd the plugin to yourmkdocs.ymlMkDocs configurationfile:plugins:-mkdocs-nav-enhancementsKnown issuesWhen changing the page title, or collapsing single-page folders, this can sometimes result in the effective page title being quite different. Currently this plugin does not re-sort the nav bar alphabetically when this happens.A second issue is that these options are not independently controllable, at least not in the first version; it's all or nothing for now!ContributingSource code is hosted atGitHub.Please report issues and feature requests onGitHub Issues.Pull Requests are also welcome!