Skip to main content

MkDocs Audio

This plugin allows you to embed audios on the documentation pages using a simple Markdown syntax.

Installation

Enable the plugin in the mkdocs.yml file:

plugins:
  - mkdocs-audio

See how to use MkDocs Plugins

Usage

![type:audio](./audio/sample_audio.mp3)

License

The MIT License (MIT)

Copyright (c) 2023 Mikalai Lisitsa

Permission 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.


Strongly based on https://pypi.org/project/mkdocs-video

Metadata

Release files for mkdocs-audio 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-audio 0.0.2
File Size Uploaded Provenance
mkdocs_audio-0.0.2.tar.gz 3.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-audio 0.0.2
File Interpreter ABI Platform
mkdocs_audio-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 7.9 kB

Release files / mkdocs_audio-0.0.2.tar.gz

Download URL mkdocs_audio-0.0.2.tar.gz
Size 3.6 kB
Tags Source
SHA-256 checksum
How to use checksums
62ef4829949d409bbc55cd777e0e30adb724f20f51329fb9b33a5cdc83f390fd
BLAKE2b-256 checksum
How to use checksums
35ffbd14ee283683a4b46ff2071d3d9140dd6e95166bcf9405caeb08ca947433
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.6

Release files / mkdocs_audio-0.0.2-py3-none-any.whl

Download URL mkdocs_audio-0.0.2-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c9d3e9ef83894d5e338575483ecb18a2ef8e735cc3c3a52056ac4aea19d8823b
BLAKE2b-256 checksum
How to use checksums
53fcd51a462101b903c9df437118b11d09fbefde3b96870594b3e19590082b05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.6

Security for mkdocs-audio 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page