Saravanan666/pypi-org huggingface dataset:
Package: mkdjangovirtualenv
Performs the commandmkvirtualenv ENV_NAME, but also:sets the directory to jump to when the virtualenv is activatedsets the PYTHONPATH and DJANGO_SETTINGS_MODULE in the postactivate hookauto-installs dependencies if there is a requirements.txt fileauto-inits git submodules if there are anyThis is intended to save environment setup busywork after pulling down a django project from github.This does not run django-admin.py startproject, instead it is for configuring the environment for an existing django project. If you are looking for a way to create an empty django project with virtualenvwrapper, check out the [virtualenvwrapper.django template plugin for virtualenvwrapper](http://www.doughellmann.com/projects/virtualenvwrapper.django/).Usagemkdjangovirtualenv [–settings DJANGO_SETTINGS_MODULE] ENV_NAME [PROJECT_DIRECTORY]Options--settingsDJANGO_SETTINGS_MODULEProvide a python import path for the settings file.
Defaults to project.settingsENV_NAMEThe name for the virtualenvPROJECT_DIRECTORYProvide a path to the root of the project. May be a
relative path, defaults the current working directory.Installationsudo pip install mkdjangovirtualenvThis will pull down the latest copy of the scripts from PYPI and place them in your path. You can then run themkdjangovirtualenvscript directly.For the best expierence, source themkdjangovirtualenv.shfile just after your sourcevirtualenvwrapper.shin your startup scripts. For example, my~/.bash_profilehas:export WORKON_HOME=$HOME/.virtualenvs
source /usr/local/bin/virtualenvwrapper.sh
source /usr/local/bin/mkdjangovirtualenv.shThe benefit of this approach is that it makes it a bash function instead of a script, so it will actually activate the new virualenv for you, whereas the script would have needed to be run withsourceto have the same affect.
Package: mkdocs
MkDocsProject documentation with MarkdownMkDocs is afast,simpleanddownright gorgeousstatic site
generator that's geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single YAML
configuration file. It is designed to be easy to use and can be extended with
third-party themes, plugins, and Markdown extensions.Please see theDocumentationfor an introductory tutorial and a full
user guide.FeaturesBuild static HTML files from Markdown files.Use Plugins and Markdown Extensions to enhance MkDocs.Use the built-in themes, third party themes or create your own.Publish your documentation anywhere that static files can be served.Much more!SupportIf you need help with MkDocs, do not hesitate to get in contact with us!For questions and high-level discussions, useDiscussionson GitHub.For small questions, a good alternative is theChat roomon
Gitter/Matrix.To report a bug or make a feature request, open anIssueon GitHub.Please note that we may only provide
support for problems/questions regarding core features of MkDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.But, such questions arenotbanned from thechat room.Make sure to stick around to answer some questions as well!LinksOfficial DocumentationLatest Release NotesCatalog of third-party plugins, themes and recipesContributing to MkDocsThe MkDocs project welcomes, and depends on, contributions from developers and
users in the open source community. Please see theContributing Guidefor
information on how you can help.Code of ConductEveryone interacting in the MkDocs project's codebases, issue trackers, and
discussion forums is expected to follow thePyPA Code of Conduct.LicenseBSD-2-Clause
Package: mkdocs-abs-rel-plugin
Mkdocs absolute to relative link converterMkdocs officially only supports relative links. While this makes sense there are situation where it is useful to make use of absolute links. For example when creating a document with absolute links to an image folder.
If that file is to be moved later on, links are kept intact.Installationpipinstallmkdocs-abs-rel-pluginUsageIn yourmkdocs.ymlfile addabs-to-relto the plugins entry:plugins:-abs-to-rel
Package: mkdocs-asciinema
mkdocs-asciinemaA Mkdocs Plugin for asciinema player.SetupInstall the plugin using pip:pip install mkdocs-asciinemaActivate the plugin inmkdocs.yml:extra_css:-stylesheets/asciinema-player.cssextra_javascript:-javascripts/asciinema-player.min.jsplugins:-search-mkdocs-asciinemaUsage![asciicast](/images/asciinema/tmpzuu_levn-ascii.cast)
Package: mkdocs-asciinema-player
mkdocs-asciinema-playerA Mkdocs Plugin to include asciinema player in your documentation.Quick SetupInstallationInstall the plugin via pip :pipinstallmkdocs-asciinema-playerConfigureIn yourmkdocs.yml, addasciinema-playerto thepluginssection :plugins:-search-asciinema-playerUsageIn your MkDocs docs folder, add anyasciinema.castfile and add this to any markdown page :```asciinema-player{"file": "assets/asciinema/bootstrap.cast"}```MoreFor more information on the plugin, you can visit the the followingwebsiteYou will find the complete documentation of the plugin, examples of use, installation and configuration instructions.
Package: mkdocs-asyncapi-plugin
Mkdocs Async API PluginSetupInstallasyncapi/generatornpminstall-g@asyncapi/generatorInstall this plugin.pipinstallmkdocs-asyncapi-pluginAddrender_asyncapitomkdocs.yml:plugins:-render_asyncapiUsageCreate a new markdown file which contains only this line:!!asyncapi <path-to-spec-file>!!path-to-spec-fileis the path to the AsyncAPI spec file relative to the root of the repository (where you runmkdocs).Then, the entire content of this file will be the AsyncAPI spec.
Package: mkdocs-auto-tag-plugin
mkdocs-auto-tag-pluginThis plugin is designed to add tags to files based on their path (parent direcctories or file name).DocumentationThis README is just a short intro to the package.
For a quick start and detailed information please see thedocumentation.
The documentation is also available in thedocsfolder of the source code and can be built localy withMkDocs.TestsThe files in thedocs/test/directory implicitely work as tests.
They should be tagged correctly.Notable changes0.1.3Just fixed theDeprecationWarningforwarning_filter0.1.2Just small documentation changes. But I needed to increase the version number to remove the!!! Warning: Pre alpha: This is currently just a PoC for myselfline from the PyPI site0.1.1Added support for assigning lists of tag to globs.Added regex supportCapture groups can be used to generate dynamic tags0.1.0Implemented working prototype that uses custom globs for the file path matching.0.0.1Reserved name on PyPI
Package: mkdocs-backlinks
mkdocs-backlinksThis is a plugin for adding backlinks to your mkdocs generated pages.Mkdocs is an awesome tool not only for documentation, but also for publishingdigital gardens.
Backlinks are a desirable component when building such digital gardens, as they enable the ability to explore content
based on how the knowledge interconnects instead of just looking at page navigation.SetupInstall the plugin using pip:pip install mkdocs-backlinksActivate the plugin inmkdocs.yml:plugins:-mkdocs-backlinksNote: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.Configignored_pages- A list of page titles that will be excluded from the backlinks.plugins:-mkdocs-backlinks:ignored_pages:['Tags','Home']UsageThis plugin will add abacklinksattribute to the Jinja page context, which can be used to add backlinks at any point
in your template. Here is an example of it:...

{% if backlinks %}<h3>Backlinks:</h3><ul>{% for backlink in backlinks %}<li><ahref="/{{ backlink.url }}">{{ backlink.title }}</a></li>{% endfor %}</ul>{% endif %}

...That meansyou need to have a template that supports backlinks, or you can alter the template you are using with the
snippet above.Writing NotesI have been using this to publish my Obsidian vault, and there are sometricksto make it work well:Obsidian is smart and will resolve links even if they don´t refer to a valid file path. This is not
true for mkdocs and the backlinks plugin -- you need to write valid links in your markdown files, either
absolute or relative links.Absolute links are absolute related to the root of the/docsfolder, not to your computer filesystem.Following those two rules will allow you to go straight from obsidian to mkdocs with cool backlinks.See AlsoMore information about templateshere.More information about blockshere.Thanks toThe creator of this awsome mkdocs plugin template:https://github.com/byrnereese/mkdocs-plugin-template
Package: mkdocs-badges
mkdocs-badgesThis package allows you to add badges to your mkdocs site.DocumentationThis README is just a short intro to the package.
For a quick start and detailed information please see thedocumentation.
The documentation is also available in thedocsfolder of the source code and can be built localy withMkDocs.TestingThe documentation also serves as a test of the plugin.
A hidden test page is available at/test.Build the documentation with the latest source code:pipinstall.&&mkdocsserve-t<theme>Themes that sould work aremkdocs,readthedocs, andmaterial.Unit testsThe github repository now contains some unit test.
You can run them against the current code with the following command (issued in the root directory of the repository):pipinstall.&&python-munittestNotable changesVersion 0.4.2Detect markdown tables even if they have only a single dash in the header. Fixes#4Option to disable warnings (use this at your own risk) by addingdisable_warnings: Trueto the plugin config in yourmkdocs.ymlVersion 0.4.1Now requires MkDocs 1.5 or newerThe included script is now marked asasyncby default, maybe improving loading times a tiny bit. This can be disabled by addingasync: Falseto the plugin config in yourmkdocs.ymlVersion 0.4.0Now requires MkDocs 1.4 or newerUpdated the layout rules for badges. This should better handle oversized contents (like images or very long texts).Version 0.3.4Added single element badgesVersion 0.3.3Added tags badgesVersion 0.3.1Better error handling, fixed a crashStarted adding unit testsVersion 0.3.0Breaking changes to the badges formats. See themigration guideAdded support for reference linksVersion 0.2.0Each badge now needs to be the only thing on its lineBadges inside code blocks are no longer parsedThe|endat the end of custom badges is no longer neccessary. A simple|is enough. This shorter form is recommended from now on.Documentation is now in thedocsfolder in the form of a mkdocs websiteAdded link badges
Package: mkdocs-bibtex-recursive
mkdocs-bibtexAMkDocsplugin for citation management using bibtex.SetupInstall the plugin using pip:pip install mkdocs-bibtexNote:This plugin requires pandoc to be installed on your system.If you're having trouble with pandoc, try installing the conda-forge version of pypandoc:conda install -c conda-forge pypandocwhich will install a version with built in pandoc binariesNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - bibtex:
      bib_file: "refs.bib"
markdown_extensions:
  - footnotesThe footnotes extension is how citations are linked for now.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.Optionsbib_file- The path or url to a single bibtex file. Path can either be absolute or relative tomkdocs.yml. Example URL:https://api.zotero.org/*/items?format=bibtexbib_dir- Directory for bibtex files to load, same as above for path resolutionbib_command- The syntax to render your bibliography, defaults to\bibliographybib_by_default- Automatically append thebib_commandat the end of every markdown document, defaults totruefull_bib_command- The syntax to render your entire bibliography, defaults to\full_bibliographycsl_file- The path or url to a bibtex CSL file, specifying your citation format. Defaults toNone, which renders in a plain format. A registry of citation styles can be found here:https://github.com/citation-style-language/stylescite_inline- Whether or not to render citations inline, requirescsl_fileto be specified. Defaults toFalse.UsageIn your markdown files:Add your citations as you would if you used pandoc, IE:[@first_cite;@second_cite]Add\bibliography, or the value ofbib_command, to the doc you want your references rendered (ifbib_by_defaultis set to true this is automatically applied for every page).(Optional) Add\full_bibliography, or the value offull_bib_command, to where you want the full bibliography rendered.Note: This is currently not working properly, since this plugin can't dictate the order in which files are processed. The best way to ensure the file with the full bibliography gets processed last is to use numbers in front of file/folder names to enforce the order of processing, IE:01_my_first_file.md(Optional) Configure thecsl_fileoption to dictate the citation text formatting.
Package: mkdocs-blogging-plugin
mkdocs-blogging-pluginA mkdocs plugin that generates a blog page listing selected pages, sorted by time. It supports:Automatic blog page generationTagsCategory-level customizationTemplate-based customizationDemo site:https://liang2kl.github.io/mkdocs-blogging-plugin-examplePrerequisitesOnlymaterialtheme is adapted by farnavigation.instantfeature cannot be enabled if blog paging is onPull requests are welcome to break these constraints.Installation# macOS or Linuxpip3installmkdocs-blogging-plugin# Windowspipinstallmkdocs-blogging-pluginUsageA complete guide is available athttps://liang2kl.github.io/mkdocs-blogging-plugin.The easiest way to setup everything from scratch is generating your project fromthe template repository.CreditsInspired bymkdocs-git-revision-date-localized-pluginandmkdocs-material-blog.
Package: mkdocs-boring-theme
MkDocs Boring ThemeThis is the MkDocs Boring Theme.
It is based on the CSS frameworkMinwhich claims to be one of the slimmest but also one of the most compatible CSS frameworks.Check out the demo page to get a feeling of this theme.GoalThe goal is to provide a lightweight theme which still does not look too awkward.Minpromotes itself as being only 995 bytes, which is hard to challenge.It's ultimately small size requires a few overwriting features which can be found incss/boring.css.Install & UsageThe boring theme is packaged and available on PyPI:pip install mkdocs-boring-themeIf you want to use the theme in your MkDocs project simply include it in themkdocs.yml:theme:
  name: boringConfigurationThe theme allows the usage of two new configuration parameters:provider_name: Example
provider_url: https://example.comThe provider will be shown in the top-left corner which can link to the providers home page.Todo ListThis theme is a work in progress. It lacks a few features, which I try to list hereNested menus with dropdown effectsMinimizingcss/boring.cssLicenseMIT LicenseCopyright 2020 Max ResingPermission 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.
Package: mkdocs-branchcustomization-plugin
MkDocs Branch Customization PluginThis plugin allows configuration options to be overridden on a per-branch basis.
Branches are matched with regular expressions.An example for adding CSS to themasterbranch might be:plugins:-branchcustomization:update_config:-branch:/master/extra_css:-css/master_branch.cssNote that this willoverridethe globalextra_cssvalue.To customize every branchexceptmaster:plugins:-branchcustomization:update_config:-branch:/(?!^master$)/+extra_css:-css/draft.cssextra_js:-js/draft.jsIn this case the+extra_cssindicates that this list should beappendedto
the globalextra_cssvalue, rather than overriding it, whileextra_jsoverrides
the global value.
Package: mkdocs-bulma-classes-plugin
Mkdocs Bulma Classes PluginAdd support toBulma CSS frameworkinMkdocs.Inspired bymkdocs-bootstrap-tables-plugin.This plugin inject first in the Markdown of the page and then in the raw html elements produced by Mkdocs from Markdown all necessary classes for styling with Bulma framework. I'll try to follow in the most pedantic way the lastCommonMarkspecification released before supporting other versions.Table of Contents:How to InstallHow to useSee alsoHow to InstallUse pip to install the plugin (or use your preferred dep manager for Python, likePoetryfor me):pip install mkdocs-bulma-classes-pluginHow to useActivate the plugin in yourmkdocs.ymlconfig file:plugins:
  - bulma-classesIf 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 doesn't need to do anything. When you build your docs with Mkdocs, after HTML page generation, this pluging inject in your tags the proper CSS class for Bulma. For example, your# Heading 1will produce the following HTML code:<h1 id="heading-1">Heading 1</h1>but enabling this plugin will produce this:<h1 id="heading-1" class="title is-1">Heading 1</h1>necessary for Bulma to render this title:For more info, look atdocs.See alsoTake a look at myBulma Themefor Mkdocs.ContributingContributions are welcome.
Package: mkdocs-calendar-plugin
mkdocs-calendar-pluginThis MkDocs plugin exposes calendar information to the 'extra' configuration variable.
This plugin is particularly useful when used together with themkdocs-macros-pluginInstallationInstall the package with pip:pipinstallmkdocs-calendar-pluginActivate the plugin inmkdocs.yml:plugins:-search-calendar-macrosConfigurationThe plugin can be configured in thepluginssection ofmkdocs.ymlas follows:plugins:-search-calendar:tz:Europe/Zurichstart:2023-02-20end:2023-06-23-macrosIt can be more convenient to use theextraconfiguration variable, so that thepluginsection ofmkdocs.ymlcan be kept clean.mkdocs-calendar-plugincan also be configured using theextra.calendar_pluginconfiguration variable as follows:extra:calendar_plugin:start:2023-02-20end:2023-06-23plugins:-search-calendar:tz:Europe/Zurich-macrosThe plugin supports the following configuration options:OptionDescriptiontzThe timezone to use for the calendar. Defaults toUTC.startThe start date of the calendar.endThe end date of the calendar.todayThe date to use as today (used mainly for testing). Defaults tonow.week_namesThe names of the weeks. Defaults to[](no week names).planThe plan to use for the calendar. Defaults to{}(no plan).extra_keyThe key to use in theextraconfiguration variable. Defaults tocal.Extra configuration variableThe plugin exposes the following information in theextra.<extra_key>configuration variable:KeyDescriptionnowThe current date and timetodayThe current dateweekdayThe current weekday (Monday == 0 ... Sunday == 6)iso_weekdayThe current ISO weekday (Monday == 0 ... Sunday == 7)week_numberThe current ISO week numberstartA copy ofextra.<extra_key>.start(only ifextra.<extra_key>.startis defined)academic_weekThe academic week number staring fromextra.<extra_key>.start(only ifextra.<extra_key>.startis defined)academic_week_nameThe academic week name (from theweek_namesarray) staring fromextra.<extra_key>.start(only ifextra.<extra_key>.startis defined)--elapsedThe number of days elapsed sinceextra.<extra_key>.start(only ifextra.<extra_key>.startis defined)elapsed_weeksThe number of weeks elapsed sinceextra.<extra_key>.start(only ifextra.<extra_key>.startis defined)awalias foracademic_week(only ifextra.<extra_key>.startis defined)awnalias foracademic_week_name(only ifextra.<extra_key>.startis defined)endA copy ofextra.<extra_key>.end(only ifextra.<extra_key>.endis defined)remainingThe remaining days toextra.<extra_key>.end(only ifextra.<extra_key>.endis defined)remaining_weeksThe remaining weeks toextra.<extra_key>.end(only ifextra.<extra_key>.endis defined)The plugin also exposes the information compited from the plan. A typical plan looks like this:plan:P1:[s01,ex01,tp01]P2:[sol1,s02,ex02,tp02]The keys of the plan (here aboveP1andP2) must exists
in theweek_namesarray (see above). The values of the plan
are boolean variables that will beTrueif the corresponding week
is the present week (or before) andFalseotherwise.
Package: mkdocs-callouts
mkdocs-calloutsA simple plugin that converts Obsidian style callouts and converts them into mkdocs supported'admonitions'(a.k.a. callouts).SetupInstall the plugin using pip:pip install mkdocs-calloutsActivate the plugin inmkdocs.yml, note that some markdown_extensions are required for this plugin to function correctly:markdown_extensions:-nl2br-admonition-pymdownx.details-pymdownx.superfencesplugins:-search-calloutsNote: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.Usagemkdocs-callouts converts the following:> [!INFO] Title
> An information callout from Obsidian
> inspired by the syntax from the Microsoft Docsand turns it into:!!! info "Title"
    An admonition block for MkDocs.
    Allowing you to edit your notes
    with confidence using Obsidian.Foldable blocksFoldable blocks are also supported. (> [!INFO]- Foldable closed by default,> [!INFO]+ Foldable open by default)Inline blocksTo turn a callout block into an inline block you can use the|leftor|rightsyntax in the type notation like so:> [!INFO|left] -> !!! info inline (alt: [!INFO | left])
> [!INFO|inline] -> !!! info inline

> [!INFO|right] -> !!! info inline end 
> [!INFO|inline end] -> !!! info inline endThe following also works, but Obsidian may not render the block type correctly.> [!INFO inline] --> !!! info inline
> [!INFO inline end] --> !!! info inline endTo get more information about inline blocks, or how to add your own custom callout blocks, check theMaterial Mkdocs Documentation.AliasesObsidian allows the use ofaliases when creating callouts, mkdocs-callouts converts these to the corresponding block type. Should you wish to disable this behaviour then you can do so by settingaliasestofalsein the plugin configuration:plugins:-search-callouts:aliases:falseBreakless lists (New in 1.11.0)Markdown specification requires a blank line between list items and other block elements, whereas Obsidian does not require this. This plugin will by default automatically add a blank line between list items and callout blocks (if none are present). Should you wish to disable this behaviour then you can do so by settingbreakless_liststofalsein the plugin configuration:plugins:-search-callouts:breakless_lists:false