Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-snippets
Mkdocs Snippets PluginThis plugin allows you to include snippets into your mkdocs documentation.FeaturesOrganize your snippets in a way that makes sense for you:Multiple snippets per file thanks to YAML syntax.Snippets are loaded from any (nested) directory inside the configuredsnippets_dir.Recursively include snippets in snippets!Documentation links in snippets are automatically converted to relative links based on the snippet's location.This allows you to link to other documentation pages from your snippets without having to worry about the snippet's location.Also works withmike!Snippets preserve the indentation of the snippet call.This allows you to use snippets in lists and code blocks without having to worry about indentation.Customizable snippet syntax.Installationpip install mkdocs-snippetspip install mkdocs-exclude(recommended)Consider adding the plugins to arequirements.txtfile alongside other Python dependencies for your project.SetupAdd the plugin to yourmkdocs.ymlfile:
It is recommended to use themkdocs-excludeplugin to exclude the snippet directory from the documentation build.
This will save you from a lot of warnings about files that are not referenced in thenavconfiguration.plugins:-search-exclude:glob:-snippets/*-snippetsUsageThe plugin will load snippets from the default directorysnippetswhich must be inside your documentation directory.
It is allowed to have any amount of files and subdirectories inside the snippet directory.These files must be in the YAML format.mySnippet:|-This is a snippet.It can contain multiple lines.# |- is the YAML Multiline IndicatormyOtherSnippet:|-This is another snippet.All top level keys in the snippet file are treated as snippets. Every key is a snippet ID.Snippet SyntaxThe default snippet syntax is@Snippet:snippetFile:snippetID@.Links in SnippetsInternal documentation links in snippets are automatically converted to relative links based on where the snippet is used.
This allows you to use documentation links in your snippets without having to worry that the snippet might be used in a directory
in which the link does not work.
Therefore, links in the snippet must be written as if they were in the root of the documentation directory.ExampleConsider the following documentation structure (docs/is the documentation's root directory):docs/API/Overview.mddocs/API/Client/Cookbook.mdA snippet would look like this:mySnippet:|-This is a snippet.It contains a link to the [API Overview](API/Overview.md).myOtherSnippet:|-This is another snippet.It contains a link to the [Client API Cookbook](API/Client/Cookbook.md).No leading slashes or relative paths are allowed. The file type (.md) must be specified.
The snippets can now be used in any file without the links breaking.ConfigurationIf you want to customize the snippet syntax or directory, you can do so by adding the following configuration:plugins:-search-snippets:directory:"mySnippetDirectory"delimiter:"|"identifier:"snip"divider_char:">"
Package: mkdocs-spellcheck
MkDocs SpellCheckA spell checker plugin for MkDocs.This plugin can use different backends
to check the spelling of words in your final HTML pages.
These backends are:codespellsymspellpyInstallationTo install all backends, use theallextra.
Otherwise specify the name(s) of the backend(s) as extra.pipinstallmkdocs-spellcheck[all]pipinstallmkdocs-spellcheck[codespell]pipinstallmkdocs-spellcheck[symspellpy]pipinstallmkdocs-spellcheck[codespell,symspellpy]Usage# mkdocs.ymlplugins:-search-spellcheck:backends:# the backends you want to use-symspellpy# as strings-codespell:# or nested configsdictionaries:[clear,rare]# known_words can also be a list of wordsknown_words:known_words.txt# ignore words in <code> tagsignore_code:yes# minimum length of words to considermin_length:2# maximum number of capital letters in a wordmax_capital:1# keep unicode charactersallow_unicode:no# skip files entirelyskip_files:-credits.md-coverage.md# whether to only check in strict modestrict_only:yesBy default, thesymspellpybackend is used.codespellThe builtin dictionaries are:clearfor unambiguous errorsrarefor rare (but valid) words that are likely to be errorsinformalfor making informal words more formalusagefor replacing phrasing with recommended termscodefor words from code and/or mathematics that are likely
to be typos in other contexts (such asuint)namesfor valid proper names that might be typosen-GB_to_en-USfor corrections fromen-GBtoen-US
Package: mkdocs-static-i18n
MkDocs static i18n pluginThe MkDocs plugin that helps you support multiple language versions of your site / documentation.Like what you :eyes:? Using this plugin? Give it a :star:!Themkdocs-static-i18nplugin allows you to support multiple languages of your documentation by adding static translation files to your existing documentation pages.Multi language support is justone.<language>.mdfile away!Even better,mkdocs-static-i18nalso allows you to build and serve localized versions of any file extension to display localized images, medias and assets.Localized images/medias/assets are justone.<language>.<extension>file away!Don't like file suffixes? You're more into a folder based structure? We got you covered as well!DocumentationCheck out theplugins' documentation here.TL;DR? There's aquick start guidefor you!Upgrading from 0.x versions:warning: Version 1.0.0 bringsbreaking changesto the configuration format of the plugin. Check out theupgrade to v1.0.0 guideto ease updating yourmkdocs.ymlfile!See it in actionThis plugin is proudly bringing localized content ofhundreds of projectsto their users.Check it out live:On this repository documentationOn my own website: ultrabug.frBut also in our hall of fame:AWS Copilot CLIOWASP Top 10Spaceship PromptFederatedAI FATEPrivacy Guides OrgComputer Science Self Learning WikiContributions welcomeFeel free to ask questions, enhancements and to contribute to this project!CreditsLogo bymax.icons
Package: mkdocs-statistics-plugin
mkdocs-statistics-plugin一个用于 mkdocs 文档统计的插件，包括全局页面数、字数、代码块行数，单页字数、代码行数、预计阅读时间等。预览：https://note.tonycrane.cc/（只有带评论的页面有单页统计）安装可以通过 pypi 直接安装：$pipinstallmkdocs-statistics-plugin也可以从源码安装$gitclonehttps://github.com/TonyCrane/mkdocs-statistics-plugin.git
$cdmkdocs-statistics-plugin
$pipinstall.# or pip install -e .使用在 mkdocs.yml 中启用插件：plugins:-statistics配置选项及解释：选项类型默认值解释pages_placeholderstr\{\{\s*pages\s*\}\}全局统计页面中页面数占位符（正则）words_placeholderstr\{\{\s*words\s*\}\}全局统计页面中字数占位符（正则）codes_placeholderstr\{\{\s*codes\s*\}\}全局统计页面中代码行数占位符（正则）page_statisticsboolTrue是否在单页中显示统计信息page_check_metadatastr如果为空，则所有页面都显示；否则包含指定 metadata 才显示单页统计信息page_read_timeboolTrue是否显示单页预计阅读时间page_templatestr单页统计信息模板相对路径（相对 docs）words_per_minuteint300每分钟预计阅读字数codelines_per_minuteint80每分钟预计阅读代码行数几种使用方式全局统计页例如在首页显示全局统计信息。需要在该页面的元数据中添加：---statistics:True---然后在该页中需要的部分添加占位符，例如：本站共有 {{ pages }} 个页面，{{ words }} 个字，{{ codes }} 行代码。单页统计需要按照上述选项填写好配置（默认开启单页统计，且应该可以适配 material 主题）。如果page_check_metadata为空，则所有页面都显示单页统计信息；否则包含指定 metadata 才显示单页统计信息。例如在我自己的设置中，包含comment的页面才显示单页统计信息（且包含nostatistics的页面不显示统计信息）：plugins:-statistics:page_check_metadata:comment高级用法自定义单页统计模板可以通过page_template选项指定单页统计模板的相对路径（相对 docs）。这个模板会被插入到 markdown 源码的一级标题下方，会传入wordscode_linesread_time（可选）三个模板参数。自定义的话可以参考提供的模板。阅读时间可以通过page_read_time选项控制是否显示单页预计阅读时间。默认开启。阅读时间的计算方式是分别计算字数和代码行数的阅读时间，然后取二者之和。可以通过words_per_minute和codelines_per_minute选项分别设置每分钟预计阅读字数和代码行数。默认情况下分别为 300 和 80，对于技术类文章这样的设置基本合理，对于其他类型例如文学类文章每分钟阅读字数应该提高到 400~600 左右较为合理。计划添加页面元信息选项来为单页设置特定的阅读时间。（咕咕咕）字数统计细节本插件的字数统计细节为：一个英文单词（包括数字）算一个字，一个中文汉字算一个字，标点都不算字；代码块（带语言的三反引号语法）中所有内容都不计入字数，而是计入代码块行数统计。具体细节见 plugin.py 中的 _clean_markdown 方法。开发可能很不稳定（反正至少我能跑起来），有任何问题欢迎 issue 提出。同时页欢迎任何 PR，尽管提就好。
Package: mkdocs-submodule-edit-uri
mkdocs-submodule-edit-uriA super simple plugin to convert the edit_uri to match in GitHub submodules, allowing you to store parts of your docs on different repositoriesInstall usingpip install mkdocs-submodule-edit-uriReplaces a givenoldstring to anewstring wherever possible on mkdocs page content.Usagerepo_url:https://github.com/user/repoedit_uri:edit/main/docs/plugins:-search-submodule-edit-uri:modules:-sub1:old:https://github.com/user/repo/edit/main/docs/SUBMODULEnew:https://github.com/user/repo-SUBMODULE/edit/main-sub1-view:old:https://github.com/user/repo/raw/main/docs/SUBMODULEnew:https://github.com/user/repo-SUBMODULE/raw/main-sub2-namedoesntmatter:old:https://github.com/user/repo/edit/main/docs/SUBMODULE2new:https://github.com/user/repo-SUBMODULE2/edit/main-sub2-namedoesntmatter-view:old:https://github.com/user/repo/raw/main/docs/SUBMODULE2new:https://github.com/user/repo-SUBMODULE2/raw/mainNote: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.Note: please have theoldvariable be as specific as possible, as to not accidentally replace any other strings that might match theoldvalue.
Package: mkdocs-swagger-ui
mkdocs-swagger-uiA MkDocs plugin created to help developer embed API Reference documentation into a mkdocs powered website.The output file can be modified by editing a template file.SetupInstall the plugin using pip:pip install mkdocs-swagger-uiActivate the plugin inmkdocs.yml:plugins:-swagger-ui:spec_url:'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'outfile:'docs/api.md'Add the CSS file to your mkdocs.yml:extra_css:-https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.43.0/swagger-ui.cssOptionsspec_url: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.outfile: The file to output. This file is typically somewhere in your docs folder.template: The name of the template file that generates the contents of the Swagger UI generated page. This file should be located in atmpldirectory.More information about plugins in theMkDocs documentation.How the plugin worksThis plugin works by loading a different template and markdown file that renders a Swagger UI page in a file's place. The key to making this work is to ensure that theoutfileplugin config value matches the filename of some file in your documentation tree, as shown below. When mkdocs encounters this file and if the file matches theoutfilethen the plugin will render a Swagger UI in place of whatever file may already be in place. In other words, the contents of the file are completed ignored, and replaced by the output of this plugin.plugins:-swagger-ui:outfile:api/quick-reference.mdpages:-'Home':index.md-'QuickReference':api/quick-reference.mdSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-swagger-ui-html
mkdocs-swagger-ui-htmlA MkDocs plugin created to help developer embed API Reference documentation into a mkdocs powered website. API specs data will be rendered withSwagger Editor-like style.SetupInstall the plugin using pip:pip install mkdocs-swagger-ui-htmlCopy overdocs/api-index.mdtodocs/api-index.mdunder your project (assuming your mkdocs working path is{root}/docs)Activate the plugin inmkdocs.yml:plugins:-swagger-ui:spec_url:'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'Optionsspec_url: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.More information about plugins in theMkDocs documentation.How the plugin worksInput: API specs YAML fileRender: The plugin takes API specs data and generatesapi-index.htmlInjection:api-index.htmlfile will be injected intoapi-index.mdfile and rendered along with other md files under the same mkdocs theme when the server is runningplugins:-swagger-ui:outfile:api/quick-reference.mdpages:-'Home':index.md-'APIReference':api-index.mdAdditional NoteWarning: mkdocs has hot loading mechanism and this plugin writes files to your local storage, so change and save files when the server is running will cause infinite hot loading issue. Please stop and restart the server before you apply any changes.TODOAdd JSON API specs supportSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-table-reader-plugin
mkdocs-table-reader-pluginMkDocsplugin that enables a markdown tag like{{ read_csv('table.csv') }}to directly insert various table formats into a page.For a workflow with other plugins see the blogpostbuilding reproducible reports with MkDocsInstallationInstall the plugin usingpip:pipinstallmkdocs-table-reader-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - table-readerIf 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.UsageIn your markdown documents you can now use:{{ read_csv('path_to_table.csv') }}Where the path is relative to the location of your project'smkdocs.ymlfile (although you canchange thatto be relative to yourdocs/directory).There arereadersfor.csv,.fwf,.json,.xlsx,.yamland.tsv. There is also theread_raw()reader that will allow you to insert tables (or other content) already in markdown format.Documentation and how-to guidesSeetimvink.github.io/mkdocs-table-reader-plugin/
Package: mkdocs-techdocs-diamond
Mkdocs Techdocs DiamondDefault configuration formkdocssites at Diamond. Designed for compatbility withtechdocsand the Diamond developer guide.UsageInstall with pip:pipinstallmkdocs-techdocs-diamondInclude in thepluginssection of yourmkdocsconfiguration (mkdocs.yml):plugins:-techdocs-diamond
Package: mkdocs-techdocs-redirects
mkdocs-techdocs-redirectPlugin to handle redirections for techdocs sites.Uses (almost) the same config and is inspired by and initially forked frommkdocs-redirects.Installingnote:This package requires MkDocs version 1.0.4 or higher.Install with pip:pipinstallmkdocs-techdocs-redirectsUsingTo use this plugin, specify your desired redirects in the plugin'sredirect_mapssetting in yourmkdocs.yml:plugins:-redirects:redirect_maps:'old':'new''old/file':'new/file''some_path':'http://external.url.com/foobar'Opposite to what mkdocs-redirects does, do not specify.mdor.html. We are running in TechDocs only.Looking to contribute?Please propose tests.More docs? How to setup on backstage?Read the TechDocs
Package: mkdocs-tech-docs-template
title: MkDocs Tech Docs Template
hide:navigationtoc<style>
  .md-typeset h1 {
    display: none;
  }
  
  .md-main__inner {
    margin-top: 0px;
  }

  .md-content__button {
    display: none;
  }
</style>!!! banner "Build flexible documentation"![Services][homepage_illustration]{ align=right width=300px height=300px}

The **MkDocs Tech Docs Template** is a Python-based alternative to the Ruby-based [Tech Docs Template][TDT] with the following benefits:

- easy to [set up][setup], [customise][customise] and [enhance][contribute]
- adapts the [MkDocs Materials theme][material] to follow the [GOV.UK style][gov-uk]
- compatible with the vast ecosystem of [MkDocs plugins][plugins]
- unified tech stack for Python-based projects

[Get Started ＞][setup]{ .md-button .md-button--primary}!!! warning inline end "Prototype"This template is under construction. As it has not yet passed an accessibility audit, we currently do not recommend using it.!!! quote "Restrictions"You can use the MkDocs Tech Docs Template even if your documentation site is not part of GOV.UK, but it must not:

- identify itself as part of GOV.UK
- use the crown or GOV.UK logotype in the header
- use the GDS Transport typeface
- say or suggest that it is an official UK government website
Package: mkdocs-terminal
mkdocs-terminalTerminal for MkDocs is a third party theme that brings theTerminal.cssstylesheet to MkDocs documentation sites.In addition to simple, monospace styling, Terminal for MkDocs also provides:a built-in Search modalcolor palette optionsrevision date displayper-page or site-wide component hidinga flexible grid for displaying inline imagessection index pagesand moreQuick startterminal.css theme for MkDocs can be installed withpip:pipinstallmkdocs-terminalAdd the following lines tomkdocs.yml:theme:name:terminalDocumentationmkdocs-terminal docsDeveloper InfoTerminal for MkDocs on GitHubTerminal for MkDocs on PyPITheme Development READMELicenseMIT LicenseCopyright (c) 2023 Natan OrganickPermission 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-terraform-monorepo-plugin
This introduces support for the !tf_modules_root syntax in mkdocs.yml, allowing you to import trees of README.md files for terraform modules directories that also contains a \*.tf file.It enables large or complex repositories to have their own tree of modules folders, whilst generating only a single Mkdocs site.This is built and maintained by the engineering community at Wunderman Thompson Commerce.It was, however, inspired by and adapted from the Spotify backstage monorepo plugin.
Package: mkdocs-tex2svg
Project Page :rod2ik/mkdocs-tex2svgThis project is part of other mkdocs-related projects.If interested, please consider having a look at this page for a more complete Documentation (Installation, Configuration and Rendering Examples), as well as all other mkdocs-related projects:Installation and Configs :https://eskool.gitlab.io/mkhack3rs/maths/tables/Rendering Examples :https://eskool.gitlab.io/mkhack3rs/maths/tables/examples/This project is the exclusive work of :Rodrigo Schwencke atrod2ik/mkdocs-tex2svgLicence :GPLv3+, CopyleftRodrigo Schwencke / rod2ik
Package: mkdocs-theme-bootstrap4
Bootstrap 4 theme for MkDocsA vanilla Bootstrap 4 theme.ScreenshotQuick startFirst install the package:$ pip install mkdocs-theme-bootstrap4Then enable it:theme:name:bootstrap4ConfigurationPlace these additional options under thetheme:section of yourmkdocs.ymlconfiguration to change the theme's behaviour.# Show next/previous links between pages?next_previous:trueBootstrap featuresSome Bootstrap components require the addition of additional CSS classes. To enable these, add the followingpluginsinmkdocs.yml:plugins:-bootstrap4-blockquotes-bootstrap4-tablesHackingFirst, install the dependencies:Python 2, for some of our dependencies.Python 3, for the package build process.Yarn, for managing frontend dependencies.Ensure that Python 2 is found on your path before Python 3, else you'll get errors fromnode-gyplater. If you're unable to do this, set the environment variablenpm_config_pythonto a command that'll launch Python 2 (py -2on Windows,python2elsewhere).On Windows:It's easiest to not put Python on your path and instead rely on thepyCLI.You'll need the build tools necessary to install native dependencies:npm install -g --production windows-build-tools.To get completion working in your editor, set up a virtual environment in the root of this repository and install MkDocs:$ pip3 install --user --upgrade setuptools twine wheel
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txtTo install the plugin onto a local MkDocs site in editable form:$ pip install --editable /path/to/mkdocs-theme-bootstrap4Upgrading dependenciesTo upgrade the dependencies, installpip-upgrader:. venv/bin/activatepip install -r requirements.dev.txtThen proceed to update the dependencies:pip-upgrade requirements.dev.txtThe node dependencies can be updated with Yarn:yarn upgradeReleasingBuild the distributable package:$ python3 setup.py sdist bdist_wheelPush it to the PyPI test instance:$ python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*Test it inside a virtual environment:$ pip install --index-url https://test.pypi.org/simple/ --no-deps mkdocs-drawio-exporterLet's go live:$ python3 -m twine upload dist/*
Package: mkdocs-theme-topdf
This is a mkdocs theme, this supports some CSS-styles to publish your documents with PDF or printing.Please see the 'Demo' sectionmkdocs-theme-topdfa mkdocs theme to generate pdf or print.[TOC]Prerequiresites/ DependencyThis plugin aim to use these softwaresmkdocs (convert markdown to html)paged.js (to generate pdf, page borders and page headers)node.js (to generate pdf, for pagedjs-cli)Installation - this pluginInstall this package with pip.from PyPipipinstallmkdocs-theme-topdffrom githubpipinstallgit+https://github.com/kuri65536/mkdocs-theme-topdfInstallation - paged.jsso paged.js uses node.js and portable chrome,
it is separate from mkdocs theme.to prepare paged.js, follow these method.from this pluginpython-mtopdf--check
>...checknode.jsandnpm...
python-mtopdf--setup
>...installtakelongtime...
python-mtopdf--test
>outputreport-3stamps.pdffrom manual$npminstallpagedjs-cli
...takelongtime...
$./node_modules/.bin/pagedjs-cli
...paged.jsmessage...How to useprepareto use mkdocs theme seematerial theme documentationsetup mkdocs.ymlchange mkdocs.yml to use this plugin.site_name:the test documenttheme:name:topdfwrite markdownwrite your documentconvert with paged.js$pagedjs-cli--outline-tagsh1,h2,h3,h4,h5,h6site/your/document.html-odocument.pdf# 1-lineAbout PDF outputpaged.js render the PDF with portable chrome and pupetterplease watch out the difference of rendering results amongthem engine and your browser.wkhtmltopdf render the PDF with webkit (old)and stable release (0.12.5) can not generate TOC with its limitation.wkhtmltopdf is more convinient to install, butI can't resolve the TOC problem and switched to paged.jsDemoa sample output of PDFAbout scripts and stylesplease seethe report sampleFAQT.B.DHistory{: .before-dl-table .table2-8 }version
: desc0.4.0
: append CSS-counters for figures and tables.0.3.0
: appendthemeto the package name0.2.7
: TOC and styles0.2.6
: append explanation for paged.js TOC and styles0.2.5
: append explanation for paged.js styles0.2.4
: append explanation for paged.js styles0.2.3
: append slash line to the no-stamp cells.0.2.2
: append screenshot0.2.1
: append explanation for dl-dt-dd tables0.2.0
: start to edit/ 3stamps0.1.2
: start to use paged.js0.1.1
: start to use mkhtmltopdf0.1.0
: append dl-dt-dd tables0.0.6
: start to editDonationsIf you are feel to nice for this software, please donation to myBitcoin| 1FTBAUaVdeGG9EPsGMD5j2SW8QHNc5HzjT |or Ether| 0xd7Dc5cd13BD7636664D6bf0Ee8424CFaF6b2FA8f |.