Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-nav-weight
mkdocs-nav-weightA simple mkdocs plugin, enables to organize Navigation in a more markdownic way.This plugin tries to read markdown resources before mkdocs, which may add some performance overhead on building.UsageFour additional keys can be configured in Markdown Metadata ( also known as "front-matter", seemetadata).weight: numberValue: number, eg:-1,2.3..., if unset, it goes0.like weight in Hugo but has some differences, used for ordering your sections/pages. Lower weight gets higher precedence. So content with lower weight will come first.weightin anindexwill be offered to its parentsection, there is a fixed value for itself, and the value is configurable, see:index_weight.headless: boolValue: bool,trueorfalse, if unset, it goesfalse.like headless in Hugo, pages/sections withheadless: truewill be hidden from nav, but these contents will still be rendered and accessible via URL.headlessin anindexwill be offered to its parentsection.Forindexonly:retitled: boolValue: bool,trueorfalse, if unset, it goesfalse.A metadata version ofsection_renamedwhich only applies thisindex's title to its parentsection,it only works whensection_renamedisfalse.empty: boolValue: bool,trueorfalse, if unset, it goesfalse.If there is anindexonly used to offer metadata for its parentsectionand without any meaningful content, settingemptytotruecan help you to hide thisindexitself.InstallationInstall withpip:pipinstallmkdocs-nav-weightAdd the following lines tomkdocs.ymlplugins:-search-mkdocs-nav-weightOptionsConfigure inmkdocs.yml:plugins:-search-mkdocs-nav-weight:section_renamed:falseindex_weight:-10warning:truereverse:falseheadless_included:falsesection_renamedDefault:false:Iftrue, section name will use thetitleof itsindexinstead of the folder name.For compatibility we have to name a folder like "C#" as "CSharp", but what we actually want is "C#" , that's what this option doesindex_weightDefault:-10:Theweightvalue forindexitself, to ensure it's always the first at the same levelwarningDefault:true:Controls whether to send aWarningwhen invalid values are detected in markdown metadatareverseDefault:false:Iftrue, sort nav byweightfrom largest to smallest.headless_includedDefault:false:An option to control whetherheadlesspages should be included innav.pageswhich is used by some plugins, eg:mkdocs-pdf-export-plugin.Iftrue,headlesspages will be included.
Package: mkdocs-nbconvert
mkdocs-nbconvertAMkDocsplug-in provides a source parser for*.ipynbJupyterNotebook files, base onnbconvert.Referenceshttps://tanbro.github.io/mkdocs-nbconvert/https://www.mkdocs.org/user-guide/plugins/Build the siteThe project itself's documentation site is a demo of how to use it.To build and serve the doc-site:pipinstall-rdev.requirements.txt
mkdocsserveThen openhttp://127.0.0.1:8000in your browser.
Package: mkdocs-newsletter
MkDocs NewsletterMkDocs plugin to show the changes of documentation repositories in a user
friendly format, at the same time that it's easy for the authors to maintain.It creates daily, weekly, monthly and yearly newsletter articles with the
changes of each period. Those pages, stored under theNewsletterssection, are
filled with the changes extracted from the commit messages of the git history.
The changes are grouped by categories, subcategories and then by file using the
order of the site's navigation structure.RSS feedsare also
created for each newsletter type, so it's easy for people to keep updated with
the evolution of the site.It assumes that you're usingsemantic versioningor ourenhanced versionto create your commits. Only
those changes that are interesting to the reader will be added to the
newsletter. You can usemkdocs-rss-plugininstead if this
workflow doesn't feel good.Checka live
version.HelpSeedocumentationfor more details.InstallingYou should check theinstall
docs, but in short,
you'll need to:pipinstallmkdocs-newsletterAnd enable this plugin, by changing yourmkdocs.yml.plugins:-git-revision-date-localized:type:timeago-autolinks-section-index-mkdocs-newsletterContributingFor guidance on setting up a development environment, and how to make
a contribution tomkdocs-newsletter, seeContributing to
mkdocs-newsletter.Donations<a href="https://liberapay.com/Lyz/donate"><img alt="Donate using
Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>
orIf you are using some of my open-source tools, have enjoyed them, and want to
say "thanks", this is a very strong way to do it.If your product/company depends on these tools, you can sponsor me to ensure I
keep happily maintaining them.If these tools are helping you save money, time, effort, or frustrations; or
they are helping you make money, be more productive, efficient, secure, enjoy a
bit more your work, or get your product ready faster, this is a great way to
show your appreciation. Thanks for that!And by sponsoring me, you are helping make these tools, that already help you,
sustainable and healthy.LicenseGPLv3
Package: mkdocs-no-sitemap-plugin
Disable Mkdocs' sitemapThis plugin disables the generation of a sitemap in Mkdocs sites.This is useful if you build and commit documentation on every commit and don't want to
see the git history cluttered with changes tositemap.xmland in particularsitemap.xml.gz.Installationpipinstallmkdocs-no-sitemap-pluginUsageIn yourmkdocs.ymlfile addno-sitemapto the plugins entry:plugins:-no-sitemap
Package: mkdocs-obsidian-support-plugin
mkdocs-obsidian-support-pluginPlugin formkdocs-materialto convert semantic in documentation
fromobsidianto mkdocs-material.pip install mkdocs-obsidian-support-pluginUsageActivate the plugin in mkdocs.ymlplugins:-obsidian-supportfeaturesobsidian callout/block styled admonition->mkdocs-material admonitionobsidian comment->html commentobsidian wikilink image->mkdocs-material mdlink image&image with md_in_htmlobsidian embed pdf->html embed pdfobsidian tags->mkdocs-material search[!note]Some featuresrequire setupto activate it.
If you interested in specific feature, see the documentation.github-pages[!tip]Seehttps://ndy2.github.io/mkdocs-obsidian-support-plugin/for more detailsOther plugins that helps mkdocs + obsidianhttps://github.com/sondregronas/mkdocs-calloutshttps://github.com/orbikm/mkdocs-ezlinks-plugin
Package: mkdocs-onecompiler-plugin
mkdocs-onecompiler-pluginIncludeOneCompileronline compiler to your mkdocs website.RequirementsWorks only withmkdocs-materialas it ships apymdownx custom fence.Installationpipinstallmkdocs-onecompiler-pluginConfigurationHere is a minimal configuration to use the onecompiler fence# mkdocs.ymltheme:name:materialmarkdown_extensions:-attr_list-pymdownx.superfences:custom_fences:-name:onecompilerclass:onecompilerformat:!!python/name:mkdocs_onecompiler_plugin.formatterUsageThe bare minimum is to provide the language.```{.onecompiler lang="python"}
a = 3
b = 5
c = a + b
print(c)
```Then we can use all theOneCompiler APIto tweak the iframe.```{.onecompiler lang="python" listenToEvents=true filename="example.py" hideNew=true hideStdin=true hideNewFileOption=true hideTitle=true theme="dark" height="200px"}
a = 3
b = 5
c = a + b
print(c)
```DebugWe can access formatter parameters whendebug=trueis passed to the attributes.```{.onecompiler .test#wtfidlang="python" listenToEvents=true filename="example.py" hideNew=true hideStdin=true hideNewFileOption=true hideTitle=true theme="dark" debug=true}
a = 3
b = 5
c = a + b
print(c)
```You must runmkdocswith the verbose flag-vto print debug messages....
INFO-Buildingdocumentation...
DEBUG-Running1`config`events
INFO-Cleaningsitedirectory
DEBUG-Readingmarkdownpages.
DEBUG-Reading:index.md
DEBUG-mkdocs_onecompiler_plugin:source:a=3b=5c=a+bprint(c)DEBUG-mkdocs_onecompiler_plugin:language:onecompiler
DEBUG-mkdocs_onecompiler_plugin:css_class:onecompiler
DEBUG-mkdocs_onecompiler_plugin:options:{}DEBUG-mkdocs_onecompiler_plugin:md:<markdown.core.Markdownobjectat0x7f5f917bb6d0>
DEBUG-mkdocs_onecompiler_plugin:attrs:{'lang':'python','listenToEvents':'true','filename':'example.py','hideNew':'true','hideStdin':'true','hideNewFileOption':'true','hideTitle':'true','theme':'dark','height':'200px'}DEBUG-mkdocs_onecompiler_plugin:classes:['test']DEBUG-mkdocs_onecompiler_plugin:id_value:wtfid2
DEBUG-mkdocs_onecompiler_plugin:kwargs:{}DEBUG-mkdocs_onecompiler_plugin:debug:True
DEBUG-mkdocs_onecompiler_plugin:<iframeid="wtfid2"referrerpolicy="no-referrer"name="wtfid2"class="onecompiler test"src="https://onecompiler.com/embed/python?availableLanguages=true&hideLanguageSelection=false&hideNew=true&hideNewFileOption=true&disableCopyPaste=false&hideStdin=true&hideResult=false&hideTitle=true&listenToEvents=true&theme=dark"height="200px"width="100%"onload='this.contentWindow.postMessage({eventType: "populateCode",language: "python",files: [{"name": "example.py","content": String.raw`a = 3b = 5c = a + bprint(c)`}]}, "*");'></iframe>
DEBUG-Copyingstaticassets.
...
Package: mkdocs-openapi-markdown-plugin
MkDocs OpenApi Markdown PluginThis plugin generates markdown file from openapi spec file. (json or yaml)ConfigurationAdd following lines to yourmkdocs.ymlconfiguration file:plugins:
  - openapi_markdown:
      enabled: true
      openapi_file: openapi.json
      output_file: api_doc.mdInstallpip install mkdocs-openapi-markdown-plugin
Package: mkdocs-open-in-new-tab
MkDocs - Open in a new tab pluginThis plugin adds JS code to open outgoing links and PDFs in a new tab.The automatic opening of links in a new tab is a common feature of modern websites. It is also a good practice for accessibility. However, it is not a default behavior of Markdown. This plugin adds a JavaScript code to your website that opens external links and PDFs in a new tab.Look at thedemo.InstallationInstall the plugin using pip fromPyPI:pipinstallmkdocs-open-in-new-tabUsageAdd the plugin to yourmkdocs.yml:plugins:-search-open-in-new-tabTestingLink toGoogleandGitHub.
Both should links should open in a new tab.Relative link toRelative linkshould open in the same tab.Sample PDF link toPDFshould open in a new tab (pdf fromhere).How does it work?The plugin adds a JavaScript code to your website that opens external links and PDFs in a new tab. Injection of the code is done using theon_page_contexthook. The code is injected into the<head>section of the page as a<script>dependency of theopen_in_new_tab.jsfile. The code is automatically added to all pages of your website.The functionexternal_new_windowchecks if the link is external using thehostnameproperty of theaelement. If the link is external, thetargetattribute is set to_blankand therelattribute is set tonoopener. Thenoopenerattribute is used to prevent the new tab from accessing thewindow.openerproperty and ensures that the original page will not be able to access the new tab.The same way is used to open PDF links in a new tab.Show source codeLook at this sourceopen_in_new_tab.js:// Description: Open external links in a new tab and PDF links in a new tab// Source: https://jekyllcodex.org/without-plugin/new-window-fix///open external links in a new windowfunctionexternal_new_window(){for(letc=document.getElementsByTagName("a"),a=0;a<c.length;a++){letb=c[a];if(b.getAttribute("href")&&b.hostname!==location.hostname){b.target="_blank";b.rel="noopener";}}}//open PDF links in a new windowfunctionpdf_new_window(){if(!document.getElementsByTagName){returnfalse;}letlinks=document.getElementsByTagName("a");for(leteleLink=0;eleLink<links.length;eleLink++){if((links[eleLink].href.indexOf('.pdf')!==-1)||(links[eleLink].href.indexOf('.doc')!==-1)||(links[eleLink].href.indexOf('.docx')!==-1)){links[eleLink].onclick=function(){window.open(this.href);returnfalse;}}}}functionapply_rules(){external_new_window();pdf_new_window();}if(typeofdocument$!=="undefined"){// compatibility with mkdocs-material's instant loading feature// based on code from https://github.com/timvink/mkdocs-charts-plugin// Copyright (c) 2021 Tim Vink - MIT License// fixes [Issue #2](https://github.com/JakubAndrysek/mkdocs-open-in-new-tab/issues/2)document$.subscribe(function(){apply_rules();})}LicenseThis project is licensed under the terms of the MIT license.
Package: mkdocs-pagelist-plugin
PageListPlugin for MkDocsPageListPlugin is a plugin for MkDocs that dynamically generates lists of pages based on tags, folders, and other criteria directly within your markdown files. It's especially useful for creating dynamic references to other parts of your documentation based on shared tags or directory structure. It may need tweaking for your needs.  The use of grouping by folders is helpful if you use the DiÃ¡taxis framework to organise your documents.  I have all my documents listed under the folders - Tutorials, How-to, Reference,
Explanation. Tags are used to cross connect across those folders with features, functions or intended audience.InstallationTo install the plugin, use the following command:pipinstallmkdocs-pagelist-pluginUsageTo use the PageListPlugin, add it to yourmkdocs.ymlconfiguration file under the plugins section:plugins:-search-mkdocs-pagelist-pluginNote: If you have nopluginsentry in your config file yet, you'll need to add it before adding PageListPlugin, as MkDocs enables only thesearchplugin by default.ExamplesList other pages sharing the same tags as the current page:{pagelist}List 10 pages sharing the same tags as the current page:{pagelist 10}Group pages by folder, sharing the same tags as the current page:{pagelist g}List pages tagged with 'draft':{pagelist 5 draft}Combine multiple tags ('draft' and 'leads'):{pagelist 10 draft leads}Include pages with 'leads' tag but exclude those with 'draft' tag:{pagelist 10 -draft leads}Group pages by folder, tagged with 'leads':{pagelist g leads}Group pages by folder, tagged with 'leads' but not 'draft':{pagelist g leads -draft}List pages tagged with 'leads' in the 'how-to' folder:{pagelist 10 leads | how-to}Generate a report of all{pagelist}commands used across the site:{pagelist i}HTML and CSSThe rendered code looks something like this:<divclass="pagelist"><h3class="pagelistheading">{folder.capitalize()}</h3><ulclass="pagelistlist"><li><ahref="../../{page.url}">{page.title}</a></li></ul></div>LicenseThis project is licensed under the MIT License.
Package: mkdocs-page-pdf
Mkdocs Page to PDFAn Mkdocs plugin to generate a PDF file for each MkDocs page usingpyppeteer(chrome headless)
and add a download button.How to useInstall the package with pip:pipinstallmkdocs-page-pdfEnable the plugin in your mkdocs.yml:plugins:# - ...-page-to-pdf# should be lastOptionsTo set different options use the following syntax.plugins:# - ...-page-to-pdf:# Options heredisable(bool): Disable pdf rendering useful to quickly disable it without removing the plugin config. Defaults toFalse.disableOnServe(bool): Disable pdf rendering when usingmkdocs serve. Defaults toFalse.The following options are directly induced frompyppeteer options:scale(float): Scale of the webpage rendering, defaults to1.0.displayHeaderFooter(bool): Display header and footer.
Defaults toFalse.headerTemplate(str): HTML template for the print header. Should
be valid HTML markup with following classes.date: formatted print datetitle: document titleurl: document locationpageNumber: current page numbertotalPages: total pages in the documentfooterTemplate(str): HTML template for the print footer. Should be valid HTML markup with the same classes asheaderTemplate.printBackground(bool): Print background graphics. Defaults toFalse.landscape(bool): Paper orientation. Defaults toFalse.pageRanges(string): Paper ranges to print, e.g., '1-5,8,11-13'. Defaults to empty string, which means all pages.format(str): Paper format. Defaults toA4.margin(dict): Paper margins.top(str): Top margin, accepts values labeled with units, defaults to20px.right(str): Right margin, accepts values labeled with units, defaults to20px.bottom(str): Bottom margin, accepts values labeled with units, defaults to20px.left(str): Left margin, accepts values labeled with units, defaults to20px.pageLoadOptions(dict): Page load options (seethis).timeout(int): Maximum time in milliseconds, defaults to30000.waitUntil(str): When to consider navigation succeeded, defaults toload.exclude(list) : List of glob pattern to excludeTroubleshootingRunning in a docker container (ci/cd)Depending on what image you are using you may encounter some issue runningpyppeteer:Browser closed unexpectedlyThis is due to some missing shared librairies used by Chrome Headless.Related issue :https://github.com/pyppeteer/pyppeteer/issues/194See thisarticleand thisguideReady-to-use docker image :https://github.com/brospars/docker-mkdocsSlow build on serveYou can usedisableordisableOnServeoptions to disable the pdf rendering (entirely or on serve) but you can also
use themkdocs serve --dirtyreloadflag to only rebuild modified files on the fly.Blank page at the endDue to achrome buga blank page can appear at the end of the PDF you can remove it by addin the following to you extra.css :body{contain:strict;}Special thanksThis plugin was inspired bymkdocs-with-pdfandmkdocs-pdf-export-pluginbut without usingweasyprintand insteadpyppeteer(chrome headless) to have a render
closer to what you have in your chrome browser.
Package: mkdocs-pages-j2-plugin
mkdocs-pages-j2-pluginThis plugin builds.pagesfiles from.pages.j2files, using Jinja2 to render the templates.
This plugin is particularly useful when used together with themkdocs-awesome-pages-plugin.InstallationInstall the package with pip:pipinstallmkdocs-pages-j2-pluginActivate the plugin inmkdocs.yml:plugins:-search-pages-j2-awesome-pagesConfigurationThe plugin can be configured in thepluginssection ofmkdocs.ymlas follows:plugins:...- pages-j2:use_extra:true...Ifuse_extrais set totrue(the default), the plugin will use theextrasection ofmkdocs.ymlas context for
rendering the templates. Otherwise, the plugin will use the full configuration.Note that this feature has been added in version 0.3.0 and is a breaking change from version 0.2.x. Setuse_extratofalseif you want the same behaviour as in pre 0.3.0 versions.UsageExample of a.pages.j2file:title: Page Title
nav:
    - Welcome: index.md
{%- for i in range(1,3) %}
    - My Page {{ i }}: p{{ i }}.md
{%- endfor %}The plugin will render theJinja2template above and create a.pagesfile with the following content:title: Page Title
nav:
    - Welcome: index.md
    - My Page 1: p1.md
    - My Page 2: p2.md
Package: mkdocs-pagetree-plugin
mkdocs-pagetree-pluginMkDocsplugin that allows you to display the page tree. Likesitemap.xml, but for humans.Demo & Docshttps://tombreit.github.io/mkdocs-pagetree-plugin/SetupInstall the pluginPyPI package:pipinstallmkdocs-pagetree-pluginConfiguremkdocs.yml:plugins:-pagetreeUsageUse{{ pagetree }}in your Markdown page(s) where the page tree should be rendered.
Package: mkdocs-pandoc-plugin
Mkdoc Pandoc PluginThis plugin is based onhttps://github.com/HaoLiuHust/mkdocs-mk2pdf-pluginand aims to
use pandoc as a generic engine to convert to many document format that pandoc suports.An MkDocs plugin to convert content pages to many formatThe plugin will use pandoc to export all markdown pages in your MkDocs repository.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-pandoc-pluginEnable the plugin in yourmkdocs.yml:plugins:-search-pandocNote: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:-pandoc:enabled_if_env:ENABLE_PANDOC_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 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 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 file. Has no effect whencombinedis set tofalse. Default ispandoc/combined.pdf.pandoc_templateThis option allows you to use a custom pandoc template to convert markdown file to translated document files.mkdocs.yml:plugins:-pandoc: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 toHaoLiuHustfor developing themkdocs-mk2pdf-plugin.
Package: mkdocs-pdf
MkDocs PDFThis plugin allows you to embed PDFs in your documentation using standard
Markdown syntax.InstallationInstall the package with pippip install mkdocs-pdfConfiguration# mkdocs.ymlmarkdown_extensions:-attr_listplugins:-mkdocs-pdfUsageTo embed a PDF file simple use the following syntax.![Alt text](<path to pdf>){ type=application/pdf }Optionally, you can specify style constraints, e.g.![Alt text](<path to pdf>){ type=application/pdf style="min-height:25vh;width:100%" }
Package: mkdocs-pdf2image-plugin
mkdocs-pdf2image-pluginThis plugin generates images from the first page of PDF files. It is particularly useful when you want
to include PDF presentations in your documentation.InstallationInstall the package with pip:pipinstallmkdocs-pdf2image-pluginNote that this plugin uses Edouard Belval'spdf2imagepackage, which requiresPopplerto be installed on your system. Read theinstallation instructionson the pdf2image repository for more information.Activate the plugin inmkdocs.yml:plugins:-search-pdf2image:src:-path/to/*.pdf-other/**/file.pdfdpi:300format:pngConfigurationThe plugin supports the following configuration options:OptionDescriptionsrcAlistof path names to convert (seedocumentationfor details).dpiImage quality in DPI (default 200).fmtOutput image format. Valid options arejpgandpng. Defaults tojpg.sizeSize of the generated image, defaults to(None, None)or!!python/tuple [NULL, NULL]inYAML.extensionOutput file extension, defaults tofmtoption.forceForce image creation, defaults tofalse. Ittrue, the generation is done even if the image already exist.
Package: mkdocs-pdf-with-js-plugin
MkDocs PDF with JS PluginA MkDocs plugin that exports your documentation as PDF with rendered JavaScript content. This is very useful if you want to have your mermaid diagrams in your pdf documents as well. A download link will be added to the top of your documentation.RequirementsFor executing the JavaScript code ChromeDriver is used. So it is nesseccary toinstall Chrome or Chromiumdownload ChromeDriver andadd the ChromeDriver to your PATHInstallationInstall the package with pip:pipinstallmkdocs-pdf-with-js-pluginEnable the plugin in your mkdocs.yml as folowingplugins:
    - search
    - pdf-with-jsor with optionsplugins:
    - search
    - pdf-with-js:
        enable: trueNote: If you enable this plugin and you don't have plugins entry in your MkDocs config file yet, you will need to explicitly enable the search plugin. This plugin is enable by default when no plugins entry is set.You can find further information about plugins in theMkDocs documentationConfigenable- Enable or disable the PDF export.default: trueUsageWhile buildingmkdocs buildor servingmkdocs servethe documentation the pdfs get generated. They are stored insite_dir/pdfs.