python-mkdocs-material-extensions
Port variant v12
Summary MkDocs extension for Markdown (3.12)
BROKEN
Package version 1.3.1
Homepage https://github.com/facelessuser/mkdocs-material-extensions
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v11
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 22 NOV 2023, 22:51:08 UTC
Port created 01 JAN 2023, 17:21:46 UTC
Subpackage Descriptions
single [![Donate via PayPal][donate-image]][donate-link] [![Build][github-ci-image]][github-ci-link] [![Coverage Status][codecov-image]][codecov-link] [![PyPI Version][pypi-image]][pypi-link] [![PyPI - Python Version][python-image]][pypi-link] ![License][license-image-mit] # MkDocs Material Extensions > NOTE: This project is now deprecated as MkDocs for Material now implements this logic directly. > Users should migrate to using `mkdocs-material`'s `material.extensions.emoji.twemoji` and > `material.extensions.emoji.to_svg` in place of the respective `materialx.emoji.twemoji` and `materialx.emoji.to_svg` > functions provided by this library. Markdown extension resources for [MkDocs for Material][mkdocs-material] ## Install Generally, just installing MkDocs Material will automatically install `mkdocs-material-extensions`. But if you had a need to manually install it, you can use pip. ``` pip install mkdocs-material-extensions ``` But make sure you've also installed MkDocs Material as well as this won't work without it. ``` pip install mkdocs-material ``` ## Inline SVG Icons MkDocs Material provides numerous icons from Material, FontAwesome, and Octicons, but it does so by inlining the SVG icons into the source. Currently there is no easy way access these icons and arbitrarily insert them into Markdown content. Users must include the icon fonts themselves and do it with HTML. This module allows you to use PyMdown Extensions' [Emoji][emoji] extension to enable easy insertion of MkDocs Material's SVG assets using simple `:emoji-syntax:`. This is done by creating our own [emoji index][emoji-index] and [emoji generator][emoji-generator]. The custom index provides a modified version of the Emoji extensions Twemoji index. In addition to the custom index, you must also specify the associated custom generator. This will will find the appropriate icon and insert it into your Markdown content as an inlined SVG. Example: ```yaml markdown_extensions: - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg ``` Then, using the folder structure of Material's `.icons` folder, you can specify icons: ``` We can use Material Icons :material-airplane:. We can also use Fontawesome Icons :fontawesome-solid-ambulance:. That's not all, we can also use Octicons :octicons-octoface:. ``` ## Using Local Custom Icons In MkDocs, you can override theme assets locally, and even add assets to the theme. Unfortunately, the Markdown parsing process isn't aware of the MkDocs environment. Luckily, if you are using PyMdown Extensions 7.1, you can pass in custom icon paths that will be used when constructing the emoji index and include your custom SVG assets. If a folder path of `theme/my_icons` was given to the index builder, all icons under `my_project/my_icons`, even in sub-folders, would become part of the index. ```yaml markdown_extensions: - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg options: custom_icons: - theme/my_icons ``` If given an icon at `my_project/my_icons/animals/bird.svg`, the icon would be available using the emoji syntax as
Configuration Switches (platform-specific settings discarded)
PY311 OFF Build using Python 3.11 PY312 ON Build using Python 3.12
Package Dependencies by Type
Build (only) python312:dev:std
python-pip:single:v12
autoselect-python:single:std
Build and Runtime python312:primary:std
Download groups
main mirror://PYPIWHL/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960
Distribution File Information
adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31 8728 mkdocs_material_extensions-1.3.1-py3-none-any.whl
Ports that require python-mkdocs-material-extensions:v12
python-mkdocs-material:v12 Documentation that simply works (3.12)