Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-exclude-unused-files
MkDocs Exclude Unused (orphaned) FilesA simple plugin for excluding files from being included in the mkdocs output if they are not referenced on other pages.InstallationRunpip install --upgrade mkdocs-exclude-unused-filesConfigurationBasic Configuration in themkdocs.ymlfile:plugins:-exclude-unused-files:file_types_to_check:["png","jpg","jpeg","gif"]enabled:!ENV[CI,false]This configuration will exclude all files from the final mkdocs output that has one of the configured file endings and are not referenced/linked to other pages.Default typesThe plugin uses a default set of file types:png, jpg, jpeg, gif, pdf, ico, drawio, tif, tiff, zip, tar.gz, rar, ogg, mp3, mp4, vtt , ogv, mov, svg, pot, potx, ppsx, ppt, pptx, xlt, xltx, xls, xlsx, doc, docx, dot, dotx, vst, vstx, vsd, vsdxAll Configuration OptionsSettingDefaultDescriptionenabledTrueWhether the plugin is enabled when building your project. If you want to switch the plugin off, e.g. for local builds, use anenvironment variables.enabled_on_serveFalseWhether the plugin is enabled when serving your project. It does not apply ifenabledis False. It's just to explicitly enable the plugin during mkdocs serve.dry_runFalseOnly print output into the command line and don't actually delete anythingsilentFalseDon't print out the found orphan files in the build processforce_deleteFalseBy default the plugin only deletes files that are actually in the configured mkdocs output directory (site_dir). If you want to delete these files anyways due to your setup, enable this flagfile_types_to_check[]Only check these file types for their usage and delete them if necessary.file_types_override_modereplaceBehavior offile_types_to_checktowards default types:replace- uses only defined types,append- adds additional types to default list,remove- removes specified types from default.file_names_to_never_remove["favicon"]Files with these names will never get deleted, even if no usage is detected.folders_to_never_remove_from["assets"]Files in these folders will never get deleted, even if no usage is detected. Useful for always including specific static files.file_name_suffixes_to_trim["#only-light", "#only-dark"]Trim-away suffixes in this list when checking if a file-name is used. This is used for ignoring material-mkdoc's color-palette-toggle instructions (seeIssue-4).
Package: mkdocsexport
Export docsDescription:  Export documents to a single file. It makes use of a template so the format can be whatever you want (JSON, CSV, One big HTML file, what-ever).Dependenciesmkdocs > 1.1ConfigurationConfiguration options:
export_filename: Name of the exported file. Defaults todocs.jsonexport_folder: Folder to save export into. Defaults the globalsite_dirsetting (works withmkdocs serveas well)
export_template: Path to the file which contains the template for the export 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.Add configuration to mkdocs.ymlplugins:-mkdocsexport:export_filename="filename.ext"export_folder="path/to/folder"export_template="path/to/template"UsageInstall this plugin (it will also install mkdocs if required)pipinstallmkdocsexportorpipinstallgit+https://github.com/philips-labs/MkdocsExportPlugin.gitCustomizationThe layout of the exported page is a jinja2 template file. The package provides such a template by default, with the following content:[
    {% for page in pages %}
    {
        "title": "{{page.title}}",
        "file": "{{page.file.name}}",
        "content":"{{page.content|escape}}"
    }{%if loop.nextitem %},{%endif%}
    {% endfor %}
]You can also provide your own template. 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.
Package: mkdocs-exporter
MkDocs ExporterA highly-configurable plugin forMkDocsthat exports your pages to PDF files.DocumentationPyPIExamplesFeatures🚀Fast- PDF documents are generated concurrently!🎨Customizable- full control over the resulting documentsCover pages(supportsmacrosplugin)Define custom scripts and stylesheets to customize your PDF documentsDefine "buttons"at the top of your documentation pages (example)Compatible withmaterialandreadthedocsthemesCheck out some sample PDF documentshere⭐Powerful- it uses a headless browser and some awesome libraries under the hood to generate PDF filesPlaywrightto automate browsersPaged.jspolyfills are included (Paged MediaandGenerated ContentCSS modules)Sasssupport (vialibsass) for your stylesheetsPrerequisitesPython>= 3.8MkDocs>= 1.4InstallationThe plugin is hosted onPyPIand can be installed viapip(or your favourite package manager):pipinstallmkdocs-exporterUsageThree plugins are currently available:exporter(required): base plugin which must precede the othersexporter-pdf(optional): plugin that exports your pages as individual PDF documentsexporter-extras(optional): provides extra functionalities (buttons, HTML utilities...)ExampleThe following configuration excerpt frommkdocs.ymlshould cover the basic functionalities of this plugin:plugins:-exporter-exporter-pdf:concurrency:8covers:front:resources/templates/covers/front.html.j2back:resources/templates/covers/back.html.j2stylesheets:-resources/stylesheets/pdf.scss-exporter-extras:buttons:-title:Download as PDFenabled:!!python/name:mkdocs_exporter.plugins.pdf.button.enabledicon:!!python/name:mkdocs_exporter.plugins.pdf.button.iconattributes:href:!!python/name:mkdocs_exporter.plugins.pdf.button.hrefdownload:!!python/name:mkdocs_exporter.plugins.pdf.button.downloadCheck out asample PDF generated by this pluginfrom the default page of theMaterial for MkDocstheme.It has been built with some custom CSS and features cover pages.RoadmapCombine all pages as one PDFFeel free to request additional features by submitting an issue or by contributing through a pull request.LicenseThis project is licensed under theMIT License (MIT), which you can readhere.
Package: mkdocs-external-import
MKDocs External ImportImport external markdown files into your documentation site.UsageInstallmkdocs-external-import:pip install mkdocs-external-importpoetry add mkdocs-external-importAdd tomkdocs.yml:plugins:-external-importReference an external Markdown file in a codeblock:```import-external-contenthttps://raw.githubusercontent.com/acodeninja/mkdocs-external-import/main/README.md```Build your docs, or run a local development server:mkdocs buildmkdocs serveThe logs will show the following output:INFO    -  mkdocs_external_import: Importing external content from: https://raw.githubusercontent.com/acodeninja/mkdocs-external-import/main/README.md
Package: mkdocs-extra-sass-plugin
mkdocs-extra-sass-pluginThis plugin adds stylesheets to your mkdocs site fromSass/SCSS.FeaturesusingLibSasswithlibsass-python.How to useInstallationInstall the package with pip:pipinstallmkdocs-extra-sass-pluginEnable the plugin in yourmkdocs.yml:plugins:
  - extra-sassNote: 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.Create aextra_sassdirectory in your working directory(usually the same directory asmkdocs.yml), and createentry point filenamedstyle.css.sassorstyle.css.scss.(top)
├── docs
：  ...snip...
│   └── index.md
├── extra_sass
：  ...snip...
│   └── style.css.scss (or style.css.sass)  # compiler entry point file.
└── mkdocs.ymlMore information about plugins in theMkDocs documentation.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.
Package: mkdocs-ezglossary-plugin
mkdocs ezglossary pluginFeaturesThis plugin adds glossary support for mkdocs. It supportsDefining multiple glossariesLinking to glossary entries in textPrinting a summary of your glossary with definitions and
references anywhere in your documentation.Customizable outputDocumentationRead thefull documentationPrerequisitesThis plugin requires thematerial definition liststo be active or any other plugin which generateshtml description lists.Installationpip install mkdocs-ezglossary-pluginQuickstartActivationAdd the following lines to your mkdocs.yml plugins section:plugins:-search-ezglossaryDefining glossary entriesProvided you use the material definition list, adding a glossary entry
just works by adding a definition list with section specifiers anywhere
in your documentation:section:term
:   A list of specialized words with their definitionsLinking to a glossary entryYou can now link to this glossary definition using the following
syntax. This will produce a link to the definition in your documentation:-See the <section:term> for detailsPrinting a summeryNow you can place a summary of all definitions anywhere in your
documentation:# Terms and Definitions<glossary::section>
Package: mkdocs-footermatter
mkdocs-footermatter (Working title)A plug-in to extractauthors,createdandupdateddata from the YAML fronmatter to be rendered in a footer template.This solves a problem I had when batch renaming every file inside a GitHub action which would overwrite the aforementioned logs. (Renaming%20to-)Inspired bygit-revision-date-localizedandmkdocs-git-committers-plugin, without the need of using git logs.SetupInstall the plugin using pip:pip install mkdocs-footermatterActivate the plugin inmkdocs.yml:plugins:-search-footermatter:author_map:-Firstname Lastname | assets/img/firstname.png | https://github.com/firstnamelastname-Author2 | <path from "custom_dir"> | htts://github.com/author2Note: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.UsageCan be used in conjunction with the Obsidian plug-inupdate-time-on-edit-obsidianExample frontmatter:---
authors:-Firstname Lastname-Author2
created: 2022-04-09 08:52:19updated: 2022-08-13 12:18:05---Configuration optionsFronmatter keys:key_authorsfronmatter syntax for authors. Default:authorskey_createdfrontmatter syntax for date created. Default:createdkey_updatedfrontmatter syntax for date updated. Default:updatedLocale & format:localelanguage format for date_format (some options may require this to be configured, see below) fallbacks to theme language (recommended) orendate_formatWhat format to use for the dates, see below for options. Default:datetimeago_absoluteBoolean to omit theagotext. True:2 days, False:2 days ago. Default:TrueAuthor rendering options:author_mapList of authors mapped image and url values:name | img (path relative to "custom_dir" or url) | url/websiteseparator_mapseparator forauthor_map. Default|default_author_imgfallback image if missing fromauthor_map. Defaulthttps://ui-avatars.com(See template for details)default_author_urlfallback url if missing fromauthor_map. Default:/Date formatsNote: values are static and only change when re-building your docs. All formats are localized using thePendulumpackagetimeago(2 hours ago) - a readable, relative date format.date(January 1. 2022) - simple date format (LL).datetime(January 1. 2022 12:00 PM) - same as date, but with added timestamp (LLL)For custom formats just passa valid pendulum string format. Example:MMMM YYYY= January 2022TemplateAn example setup can be seen in theoverridesfolder, including some css styling and an examplemain.htmlRelevant context values:{{footermatter_updated}}{{footermatter_created}}{%- for author in footermatter_authors -%}{{author.name}}{{author.img}}{{base_url}}/{{ author.img }}{{ author.url }}{%- endfor -%}
Package: mkdocs-gallery
mkdocs-gallerySphinx-Galleryfeatures formkdocs(noSphinxdependency !).Do you loveSphinx-Gallerybut prefermkdocsoverSphinxfor your documentation ?mkdocs-gallerywas written for you ;)It relies onmkdocs-materialto get the most of mkdocs, so that your galleries look nice!The documentation for users is available here:https://smarie.github.io/mkdocs-gallery/A readme for developers is available here:https://github.com/smarie/mkdocs-gallery
Package: mkdocs-gen-files
mkdocs-gen-filesPluginforMkDocsto programmatically generate documentation pages during the buildpipinstallmkdocs-gen-filesContinue to thedocumentation site.UsageActivate the plugin inmkdocs.yml(scriptsis a required list of Python scripts to execute, always relative tomkdocs.yml):plugins:-search-gen-files:scripts:-gen_pages.py# or any other name or pathThen create such a scriptgen_pages.py(this is relative to the root,notto thedocsdirectory).importmkdocs_gen_fileswithmkdocs_gen_files.open("foo.md","w")asf:print("Hello, world!",file=f)This added a programmatically generated page to our site. That is, the document doesn't actually appear in our source files, it onlyvirtuallybecomes part of the site to be built by MkDocs.Continue to thedocumentation site.
Package: mkdocs-gen-nav-plugin
MkDocs Gen Nav PluginThis plugin generates theconfig['nav']automatically for your MkDocs documentation site by finding all markdown files from the globalconfig['docs_dir'].RulesThe following rules are used to generate the navigation:The file or directory names are used as the navigation title.If a path name starts with two digits and '_' characters, it is ignored in the title. This means that it is only used to sort the navigation list.If a path name starts with '_', it will be ignored. This means that the links to that markdown file should be a part of some other document manually.The file named "index.md" in the docs root dir will be ignored. (It will be used as Home page)ConfigurationAdd following lines to yourmkdocs.ymlconfiguration file:plugins:
  - gen_nav:
      enabled: trueExampleyou can find example inexamplesdirectoryInstallpip install mkdocs-gen-nav-pluginDevelopmentDevelopment Guide
Package: mkdocs-get-deps
mkdocs-get-depsAn extra command forMkDocsthat infers required PyPI packages frompluginsin mkdocs.yml.Installation:Alternatively through MkDocs itself:pipinstallmkdocs-get-depspipinstallmkdocsThis command guesses the Python dependencies that a MkDocs site requires in order to build. It simply prints the PyPI packages that need to be installed. In the terminal it can be combined directly with apip installcommand, as per the last example below:Usage:Alternatively through MkDocs itself:# Print dependencies of the current projectmkdocs-get-deps# Save them into a filemkdocs-get-deps>requirements.txt# Install dependencies on the flypipinstall$(mkdocs-get-deps)mkdocsget-deps

mkdocsget-deps>requirements.txt
pipinstall-rrequirements.txt

pipinstall$(mkdocsget-deps)The idea is that right after running this command, you can directly follow it up withmkdocs buildand it will almost always "just work", without needing to think which dependencies to install.The way it works is by scanningmkdocs.ymlforthemes:,plugins:,markdown_extensions:items and doing a reverse lookup based on a large list of known projects (catalog, see below).Of course, you're encouraged to use a "virtualenv" with such a command. Also note that for environments that require stability (for example CI) directly installing deps in this way is not a very reliable approach as it precludes dependency pinning.The command allows overriding which config file is used (instead ofmkdocs.ymlin the current directory) as well as which catalog of projects is used (instead of downloading it from the default location). Seemkdocs get-deps --help.MkDocs' official catalog of pluginsCheck outhttps://github.com/mkdocs/catalogand add all your general-purpose plugins, themes and extensions there, so that they can be looked up throughmkdocs get-deps.
Package: mkdocs-git-authors-plugin
mkdocs-git-authors-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-authors-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - git-authorsIf 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-authors-pluginContributingVery much open to contributions! Please readcontributing guidebefore putting in any work.
Package: mkdocs-github
Mkdocs-Github Theme for MkDocsAboutSimple Theme for Mkdocs.InstallRequired: Python 3.4+If you haven't installed MkDocs yet, use the following command to install it:$ pip install mkdocsNext, navigate to a clean directory and create a new MkDocs project with the following command:$ mkdocs new [projectname]Replace[projectname]with the name of your project (without the brackets).Then navigate to the root of your project directory:$ cd [projectname]Install  Github Themewith PIPpip install mkdocs-githubor download with zip.Configurationmkdocs.ymlfor install viazipsite_name: yourdocs
site_author: you
site_description: "you word."
site_keyword: "you word"

theme:
  name: null
  custom_dir: github
  highlightjs: true
  hljs_style: github

badge:
 github_repo: mkdocs-Github 
 github_user: g3xxmkdocs.ymlwith install viaPIPsite_name: yourdocs
site_author: you
site_description: "you word"
site_keyword: "your tag"

theme:
  name: github
  highlightjs: true
  hljs_style: github

badge:
 github_repo: antiFramework 
 github_user: g3xxLicenseMITand CSS bysindresorhus
Package: mkdocs-github-changelog
# mkdocs_github_changelogmkdocs extension to autogenerate changelog from github## Introduction## ContributingTo see the contribution guidelines, see [docs/source/developing/index.md](docs/source/developing/index.md).## Setting up for developmentCreate a virtual environment.
Install the package usingpip install-e.[dev]Then add code to the package as appropriate - submodules can be created undersrc/mkdocs_github_changelogTests can be added to the tests folder### CIThere are a set of CI checks:lint:nox-tlinttest:nox-ttestbuild:nox-tbuildspecific subfolders can be passed to the test tag in nox:nox-ttest--<subfolder1> <subfolder2>## VersioningIt is important to track and version code, and to aid that with the python packages and models,setuptools_scmis used.
This links the version reported at__version__to the git tag (+ commit hash if appropriate), to reduce the amount of
places that need editing when changing versions.For describing versions we are using semantic versioning<major>.<minor>.<patch>. Increment the:<major>version when you make incompatible API changes,<minor>version when you add functionality in a backwards-compatible manner, and<patch>version when you make backwards-compatible bug fixes.There are also codes for pre-releases and other descriptions (seehttps://semver.org/)To create a version, usegit tag<major>.<minor>.<patch>and then make sure to push that tag withgit push origin<major>.<minor>.<patch>,
or an equivalent tagging tool (e.g. Github releases).Repo created from nskit.recipes.python.package:PackageRecipe (version 0.0.post1.dev14+g7e85d99.d20231220) usingnskit.
Package: mkdocs-github-dashboard
mkdocs-github-dashboardPython Boilerplate contains all the boilerplate you need to create a Python package.Free software: Apache Software License 2.0Documentation:https://mkdocs-github-dashboard.readthedocs.io.FeaturesTODOCreditsThis package was created withCookiecutterand theaudreyr/cookiecutter-pypackageproject template.History0.1.0 (2021-10-09)First release on PyPI.
Package: mkdocs-github-wiki-edit-url
MKDocs GitHub Wiki Edit Url SupportThis plugin is to enable mkdocs to produce output that uses the GitHub Wiki-style edit URL's, e.g.https://github.com/project/repo/wiki/some/path/_editYou will need to set repo_url to your wiki URL, e.g.https://github.com/project/repo/wiki. The plugin will use repo_url//_edit as the URL style.InstallUsepip install mkdocs-github-wiki-edit-urlAdd the plugin to yourmkdocs.yml, e.g.:plugins:
  - search
  - ezlinks
  - github-wiki-edit-url
Package: mkdocs-gitlab
MkDocs GitlabThe plugin updates mkdocs config with Gitlab CI/CD variables.CI_PROJECT_TITLECI_PROJECT_DESCRIPTIONCI_PAGES_URLCI_PROJECT_URLCI_PROJECT_PATHAlso the pugin deletes the[[_TOC_]]or[TOC]tag.Installationpippip install mkdocs-gitlabUsagesite_name:Titleplugins:-gitlabLicenseMIT LICENSEContributionContribution guidelines for this project
Package: mkdocs-gitlab-review-plugin
mkdocs-gitlab-review-pluginPlugin formkdocsto
useGitLab Visual Review AppsThis plugin will automatically add the<script>tag for the Gitlab visual reviews. To use this you need to set upReview AppsandMerge Request pipelines.InstallingInstall with pip:pipinstallmkdocs-gitlab-review-pluginUsingTo use this plugin, simply add the plugin to themkdocs.ymlplugins:-gitlab_reviewConfigurationThere are a few configuration options available:optionDefaultDescriptionauthfalseA boolean to enable the Gitlab auth seeAuthentication for Visual Reviewsgitlab_urlhttps://gitlab.comThe url for the GitLab instance.script_urlhttps://gitlab.com/assets/webpack/visual_review_toolbar.jsThe url for the script to usescript_idreview-app-toolbar-scriptThe id in the HTML for the<script>tag.ContributingPull Requests are welcome.File bugs and suggestions in theGitHub Issues tracker.
Package: mkdocs-git-latest-changes-plugin
mkdocs-git-latest-changes-pluginMkDocs plugin that allows you to display a list of recently modified pages from the Git logDemo & Docshttps://tombreit.github.io/mkdocs-git-latest-changes-plugin/SetupInstall the pluginPyPI package:pipinstallmkdocs-git-latest-changes-pluginConfiguremkdocs.yml:plugins:-git-latest-changesUsageUse{{ latest_changes }}in your Markdown page(s) where the latest git changes should be inserted as a table.
Package: mkdocs-gitlinks
MKDocs GitlinksThis is a simple plugin for MKDocs that creates links to git projects easier.UsageTo use the plugin you need to set it upConfigIn the mkdocs.yml add:plugins:-mkdocs_gitlinks:MarkdownThen in the markdown you can link to git projects (currently only Github is supported) by using the syntax below:[github](orginisation/project)For example to link to this project use:[github](umaaz/mkdocs_gitlinks)OutputThe result of this is to change the link to:OptionsThere are a few options availableplugins:-mkdocs_gitlinks:show_docs:false# setting this to true will include a link to the github pages for the projectgithub_host:github.com# this allows for changing the github host name