Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-ubleiden-theme
MkDocs UBL theme for documentationMkDocs UBL is a theme for writing documentation using the Leiden University
Libraries style and colors.
MkDocs UBL template is based onMaterial for MkDocs; a theme forMkDocs.
MkDocs is static site generator geared towards (technical) project
documentation.InstallationThe MkDocs UBL theme can be installed withpip:First, make sure you have installedPython v3.*on your machine.
During the installation you will be asked if you also want to install 'pip'.
Do so, and then run the following command to install all the dependencies to
run MkDocs with the theme on your machine:pipinstallmkdocs-ubleiden-themeThis will automatically install compatible versions of all dependencies:MkDocs,Material for MkDocs,Markdown,PygmentsandPython Markdown Extensions.
There's no need to install these packages separately.Using this theme in your projectFollowing the [Styling your docs guide][style], set the theme toubleidenin
yourmkdocs.ymlconfiguration file:theme: ubleidenor:theme:
  name: ubleidenGenerating the documentationIf you have installed Python 3.* and MkDocs, you can use the commandmkdocs serve, orpython -m mkdocs servein your terminal to serve the
documentation on your development computer.
For example:C:\Users\username\Documents\my-cool-application> python -m mkdocs serveWhen you are ready to generate the final documentation files, runmkdocs buildto create a static version locally, ormkdocs gh-deployto
build and push the docs to a special branch in your remote git repository.For more information about generating and publishing the documentation, seeDeploying your Docs.
Package: mkdocs-unidata
Custom Material Theme for MkDocsA custom Material Design theme forMkDocs.Quick startInstall the latest version of Material withpip:pipinstallmkdocs-unidataAppend the following line to your project'smkdocs.yml:theme:'unidata'condaenvcreate-fenvironment.ymlsourceactivatemkdocs-unidatamkdocsserveWhat to expectResponsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google
Analytics, Disqus and GitHub.Well-designed search interface accessible through hotkeys (ForS), intelligent grouping of search results, search term
highlighting and lazy loading.For detailed installation instructions and a demo, visithttp://mjames-upc.github.io/mkdocs-unidata/LicenseMIT LicenseCopyright (c) 2016-2017 Martin DonathPermission 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 NON-INFRINGEMENT. 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-user-defined-values
mkdocs-user-defined-valuesThis is a plugin for a MkDocs which allows pages to have user defined input values.SetupInstall the plugin using pip:pip install mkdocs-user-defined-valuesActivate the plugin inmkdocs.yml:plugins:-search-user-defined-values:keywords:YOUR_AWS_REGION:placeholder:e.g. ap-southeast-2YOUR_AWS_ACCOUNT_ID:placeholder:e.g. 12355224536Note: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.Configkeywords- This is a list of keywords which you want to allow a user to modify.input-placeholder- This is a placeholder where you want the plugin to generate the form for user to provide dynamic values for each keyword. Default value is{{{user-defined-values}}}.UsageProvide a list ofkeywordsyou want a user to provide dynamically.Place{{{user-defined-values}}}in your page or template where you want to generate the form for user to provide dynamic values.Demo/Testcddemo
pipenvrunmkdocsserveReleasing a new versionBump version insetup.pyCreate distributionpipenv run python setup.py bdist_wheelCheck distributionpipenv run twine check dist/*Upload distributionpipenv run twine upload dist/* --repository mkdocs-user-defined-valuesSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-versioning
mkdocs-versioningmkdocs-versioningis a plugin formkdocs, a tool designed to create static websites usually for generating project documentation.mkdocs-versioningextends mkdocs by differentiating between different versions of documentation you may build. For example, a newer versions of some software may work differently from an older version and it is important that users of an older version of the software reads the appropriate version of the documentation in order to ensure that the user has the correct information and uses the software appropriately.SetupInstall the plugin using pip:pipinstallmkdocs-versioningNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - mkdocs-versioning:
      version: 0.3.0If 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.UsageInstructions on how to use the plugin is available athttps://zayd62.github.io/mkdocs-versioning/ContributingPlease note that mkdocs-versioning is currently inBetaand there may be missing feature/documentation so if you could help out by either:finding and reporting bugscontributing by checking out theissuesTroubleshootingCombined use of awesome-pages and mkdocs-versioningIn case of usingawesome-pagesthe order of registration within thepluginsis important. The following error may occur:Traceback (most recent call last):
  [...]
  File "/path/to/mkversion/entry.py", line 47, on_config
    for count, i in enumerate(nav):
TypeError: 'NoneType' object is not iterableYou need to make sure, that theawesome-pagesplugin is registeraftermkdocs-versioning:plugins:-mkdocs-versioning:version:"1.0"-awesome-pages
Package: mkdocs-walt
mkdocs-walt🍃 Walt is a minimal documentation theme for MkDocs.It has the following features:classless styles for semantic HTML based onwrit.csslight mode and dark mode based on system settingsan emoji favicon for browsers that support svg site iconscode syntax highlighting using highlight.jsInstallationpipinstallmkdocs-waltUsageCreate a new MkDocs project with themkdocsCLI and add the following your
project'smkdocs.yml:theme:name:waltSee theend to end example.DefaultsWalt sets the following configurations by default:site_emoji:🍃locale:entheme_color:"hsl(0,0%,100%)"theme_color_dark:"hsl(232,23%,18%)"include_header:trueinclude_nav:truehighlightjs:trueLicenseCopyright © 2023Suzen Fylke. Distributed under the MIT License.AcknowledgementsWalt useswrit.cssfor styles
andCatppuccinfor code block syntax
highlighting and dark mode color palettes.
Package: mkdocs-wavedrom-plugin
This is a mkdocs plugin, this could enable the wavedrom charts in the markdown file.Please follow the 'how to' section in reame to enable this pluginmkdocs-wavedrom-pluginA MkDocs plugin,render waveform charts in the wavedrom style.InstallationInstall this package with pip.from PyPipipinstallmkdocs-wavedrom-pluginfrom githubpipinstallgit+https://github.com/kuri65536/mkdocs-mkdocs-pluginHow to useMore information about plugins in theMkDocs documentationwrite markdown/wavedrom codeembed your wavedrom code in markdown documents.```wavedrom
{ signal: [{ name: 'Alfa', wave: '01.zx=ud.23.45' }] }
```or seea sample markdownfor the sample.setup mkdocs.ymlchange mkdocs.yml to use this plugin.site_name: test
plugins:
    - markdownwavedrom

extra_javascript:
    # - wavedrom.unpkg.js
    # - skin-default.js
    # above, place *.js in docs directory, or below from internet.
    - https://cdn.jsdelivr.net/npm/wavedrom@2.1.2/wavedrom.unpkg.js
    - https://wavedrom.com/skins/default.jsDemoseesample a test.html resultimagefrom local$python-mvenvenv
$./env/bin/pythonsetup.pyinstall
$./env/bin/mkdocsbuild
$./env/bin/mkdocsserve&$browsehttp://localhost:8000/test/index.htmlormake buildandbrowse site/test/index.html, if you have make binary.(optional) download wavedromto download javascript files to local$makedownloadThanksa lot part of this pluginwere came from mkdocs-mermaid-plugin
Package: mkdocs-webcontext-plugin
Webcontext link converter plugin for mkdocsMkDocs allows absulute paths assuming that the site is deployed to the root of the hosted website like "http://localhost/". When using the following absolute path "/assets/image1.jpg" it is actually using "http://localhost/assets/image1.jpg" which is correct if the MkDocs is deployed to the site root.When the server root is not the same as the MkDocs root, the webcontext plugin can be used to define a webcontext to use instead of the defined root. The webcontext path which can be anyting like "/projectname/documents" is used where "/" is defined.Some examples of site urls before and after using the webcontext plugin:Site UrlContextImage beforeImage afterhttp://example.com///images/img1.jpg/images/img1.jpghttp://example.com/foo/foo/images/img1.jpg/foo/images/img1.jpghttp://example.com/foo/bar/foo/bar/images/img1.jpg/foo/bar/images/img1.jpghttp://127.0.0.1:8000//images/img1.jpg/images/img1.jpghttp://127.0.0.1:8000/foo/foo/images/img1.jpg/foo/images/img1.jpgQuick startInstall the module using pip:pip install mkdocs-webcontextIn your project, add a plugin configuration tomkdocs.yml:plugins:-webcontext:context:foo/barSpecial thanks to the following repositories for guidance:byrnereese/mkdocs-plugin-templatesander76/mkdocs-abs-rel-plugin
Package: mkdocs-word-filter
mkdocs-word-filterStrips extra content from markdown files that was added e.g. for converting the files to docx using pandocStripped content can include for example:pagebreaks:https://github.com/pandocker/pandoc-docx-pagebreak-py\newpage
\tocInstallpython-mpipinstallmkdocs-word-filterUsageActive the plugin inmkdocs.yml. You can specify the ignorable strings as a list under thefilter-lines-withplugins:-search-mkdocs-word-filter:filter-lines-with:-\toc-\newpageNote: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.See AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-yaarg-plugin
mkdocs-yaarg-pluginYetAnotherAPIReferenceGenerator plugin forMKDocs.InstallationInstall package from PyPI,pip install mkdocs-yaarg-pluginthen add it tomkdocs.yml:plugins:-yaargUsage# API Reference::: some/filepath/to/module.pySeedocumentationfor other options and details.WhyAs a Python docstring documentation generator:Fast & staticyaarg's default Python generator does not depend on any runtime data.
Executing Python code to build a documentation is simply unnecessary, slow and potentially dangerous.As a general API reference generator:Language agnosticUnopinionated on how markdown output should look likeSo that one can easily exploit exisiting documentation tooling in their eco-system.
Package: mkdocs-yaml-schema-plugin
MkDocs Yaml Schema PluginMkDocs Plugin to parse yaml schema files.To use this plugin, install it with pip in the same environment as MkDocs:pip install MkDocsYamlSchemaPluginThen add the following entry to the MkDocs config file:plugins:
- yaml-schema:
    yaml_files: 
      - file: "workflow/schemas/config.schema.yaml"
        tag: "CONFIGSCHEMA"
      - file: "workflow/schemas/resources.schema.yaml"
        tag: "RESOURCESSCHEMA"In your target file, add a tag to be replaced#RESOURCESSCHEMA#
Package: mkdocs-yamp
Yet Another Multirepo PluginThis plugin allows users to define external repositories for integration into the MkDocs site.Declared repositories are added to a subdirectory within your docs directory.Users can then reference files within those repositories from their own navigation.Configplugins:-yamp:# directory within docs dir to add contenttemp_dir:"repos"# delete docs/{temp_dir} after build||serve?#  default: truecleanup:true# delete docs/{temp_dir} at the beginning of the# mkdocs invocation.start_fresh:true# declare a list of repositories or directories to add# to docs/{temp_dir}#   default: []repos:# the git repository URL to clone-url:"https://github.com/some-user/some-repo"# a list of globs to checkout# if empty or not provided, the entire repository is cloned# default: [ ]include:["README.md","docs/index.md"]# the branch of the repository to clonebranch:"main"# alternatively, you can provide a path.# a symlink will be created within docs/{temp_dir}-path:"../some-other-directory"Example Usageplugins:-search:{}-yamp:repos:-url:https://github.com/steven-terrana/mkdocs-bbranch:develop-url:https://github.com/steven-terrana/mkdocs-a# Page Treenav:-Home:-index.md-repos/local-dir/README.md-Concepts:-concepts/index.md-repos/mkdocs-b/README.md-repos/mkdocs-a/docs/concepts/concept.md
Package: mkdocs-zettelkasten
MkDocs ZettelkastenThis is aZettelkastentheme and plugin forMkDocs. It renders the MkDocs pages as cards (zettels).For more information, head on over tothe documentationDevelopmentUpdateUpdate dependencies:make updateIncrement version insetup.pyTest:make testBuild:make buildCheck if compliant with PyPI:make checkPublish the new version to PyPI:make publish
Package: mkdocs-zh
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 (new!)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 NotesMkDocs Wiki(Third-party themes, recipes, plugins and more)Best-of-MkDocs(Curated list of themes, plugins and more)Contributing 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-zip-folders
ZipFolders MkDocs PluginTheZipFoldersplugin is used to zip specified folders in your MkDocs project after the site build process. This can be helpful if you need to distribute or backup parts of your documentation.InstallationInstall the plugin using pip fromPyPI:pipinstallmkdocs-zip-foldersConfigurationTo use theZipFoldersplugin, you need to add it to yourmkdocs.ymlconfiguration file.Here is a sample configuration:plugins:-search-zip_folders:folders:-myCode-toShare-folderX/thisWillBeZippedhash_extension:".zip.hash"# default extensiondebug:true# optional - default is falsefolders- A list of folders to zip. The folders are relative to the root of the MkDocs documentation project - docs_dir (default isdocs).debug- Optional. If set totrue, the plugin will print debug messages to the console. Default isfalse.hash_extension- The extension to use for hashing folders. Default is.zip.hash.Git configurationIt is highly recommended to add the*.zip,*.zip.hashfilses to your.gitignorefile. This will prevent you from accidentally committing the zip files to your repository.Zip files will be generated automatically after each build.ContributingPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.Do You Enjoy My Work?Then definitely consider:supporting me on GitHub Sponsors:LicenseMIT
Package: mkDOCter
# mkDOCtermkDOCter is an [MkDocs](http://www.mkdocs.org/) theme based on the[DOCter template for Jekyll](https://github.com/ascott1/DOCter).## UsageUse pip to install mkDOCter. If you're using mkdocs within a[virtualenv](https://virtualenv.pypa.io/en/stable/), please be sure toinstall mkDOCter into the same virtualenv.```pip install mkDOCter```Once installed, you can add mkDOCter to your mkdocs configuraiton file:```theme: mkDOCter```## ConfigurationmkDOCter has a few config extras to customize its appearances:```extras:brand_color: "#1096CF"logo_url: http://xmlsoft.org/catalog.giflogo_alt: My Awesome Logo```*`brand_color`* controls the header and sidebar accent lines.*`logo_url`* is the URL to a logo to display in the top right.*`logo_alt`* is the alt text for the logo.## LicenseThe project is in the public domain, and all contributions to it will bereleased as such. By submitting a pull request, you are agreeing towaive all rights to your contribution under the terms of the[CC0 Public Domain Dedication](TERMS.md).If you contribute the open source work of others, please mark it clearlyin your pull request.
Package: mkdoxy
MkDoxyMkDoxyplugin forMkDocsgenerates API documentation based onDoxygencomments andcode snippetsin your markdown files.WarningExtension is in developmentand few features are not working properly.
More information inDiscussionsandIssuespages.:material-home-edit: Online Demoand:simple-github: Demo source-codeFeature List-Installation-Quick startFeature ListEasy to use:: Just addmkdoxyto yourmkdocs.ymland configure the path to your source code.Code snippets: Generate code snippets in place of your standard Markdown documentation.Multiple projects: Support for multiple projects in one documentation (e.g. C++ and Python).Multiple source directories: Configure multiple source directories in one project.Custom Jinja templates: Define custom Jinja templates for rendering Doxygen documentation.Custom Doxygen configuration: Specify custom Doxygen configuration for each project.InstallationInstall the plugin using pip fromPyPI:pipinstallmkdoxyDevelopment version with all dependencies:python-mpipinstallmkdoxy".[dev]"Install from source:pipinstallgit+https://github.com/JakubAndrysek/MkDoxy.gitQuick startmkdocs.yml:site_name:"MyMkDoxydocumentation"theme:name:materialplugins:-search-mkdoxy:projects:myProjectCpp:# name of project must be alphanumeric + numbers (without spaces)src-dirs:path/to/src/project1# path to source code (support multiple paths separated by space) => INPUTfull-doc:True# if you want to generate full documentationdoxy-cfg:# standard doxygen configuration (key: value)FILE_PATTERNS:"*.cpp*.h*"# specify file patterns to filter outRECURSIVE:True# recursive search in source directoriesContributingPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.Do You Enjoy MkDoxy or Does It Save You Time?Then definitely consider:supporting me on GitHub Sponsors:LicenseThis project is licensed under the terms of theMIT license
Package: mkeditor
## Django MKEditorA form widget that change the textfield style to the markdown.![](mk.png)## Installation1. Get the code: `pip install mkeditor`2. Add `mkedirot` to your `INSTALLED_APPS`## Usage1. In forms.py```from mkeditor.widgets import MarkdownWidgetclass ArticleForm(forms.ModelForm):class Meta:widgets = {'content': MarkdownWidget, # the content is model field}```2. In admin.py```from .form import ArticleFormclass ArticleAdmin(admin.ModelAdmin):form = ArticleFormadmin.site.register(Article, ArticleAdmin)```
Package: mkeima
mkeima: Analyze flow cytometry-based mKeima assays in Pythonmkeima is a Python library for the analysis and visualization of flow cytometry-based
mKeima assays.Installing mkeimaIf you do not already have a Python installation, we recommend installing theAnaconda distributionof Continuum Analytics,
which already contains a large number of popular Python packages for Data Science.
Alternatively, you can also get Python from thePython homepage.Notethat the mkeima package requires Python version 3.9 or higher.You can use pip to install mkeima from thePython Package Indexpip install mkeimaTo uninstall the mkeima package run the following command:pip uninstall mkeimaInstallation when using AnacondaIf you are using Anaconda, you will need to install the mkeima package into a conda
environment. Open the Anaconda navigator, activate the conda environment you want to
use, run the "CMD.exe" application to open a terminal, and then use the pip install
command as described above.Licensemkeima is licensed under theApache License 2.0.ContributorsDavid M. Hollensteinhttps://github.com/hollenstein
Package: mkepub
mkepubmkepubis a minimalistic library for creating .epub files.Pros:Easy to use, minimalistic API.Automatically generated TOC.Support for nested TOC of any depth.Support for embedded images.In-progress books are stored on disk rather than in memory, enabling
creation of large (5000+ pages, 20+ MiBs) epub files.Adherence to the EPUB3 specs.Support for most of the EPUB metadata, including language, subject,
description, and rights.Cons:No support for custom page filenames or directory structure.No support for reading or editing epub files.No support for font-embedding or most other less commonly used EPUB
features.No content validation - using broken or unsupported html code as page
content will lead to mkepub successfully creating a .epub file that
does not meet EPUB3 specifications.Probably other issues.Basic Usageimportmkepubbook=mkepub.Book(title='An Example')book.add_page(title='First Page',content='Lorem Ipsum etcetera.')book.save('example.epub')Advanced Usageimportmkepubbook=mkepub.Book(title='Advanced Example',author='The Author')# multiple authors can be specified as a list:# mkepub.Book(title='Advanced Example', authors=['The First Author', 'The Second Author'])withopen('cover.jpg','rb')asfile:book.set_cover(file.read())withopen('style.css')asfile:book.set_stylesheet(file.read())first=book.add_page('Chapter 1','And so the book begins.')child=book.add_page('Chapter 1.1','Nested TOC is supported.',parent=first)book.add_page('Chapter 1.1.1','Infinite nesting levels',parent=child)book.add_page('Chapter 1.2','In any order you wish.',parent=first)book.add_page('Chapter 2','Use <b>html</b> to make your text <span class="pink">prettier</span>')book.add_page('Chapter 3: Images','<img src="images/chapter3.png" alt="You can use images as well">')# as long as you add them to the book:withopen('chapter3.png','rb')asfile:book.add_image('chapter3.png',file.read())book.save('advanced.epub')