diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mkdocs-material-extensions.spec | 393 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 395 insertions, 0 deletions
@@ -0,0 +1 @@ +/mkdocs_material_extensions-1.1.1.tar.gz diff --git a/python-mkdocs-material-extensions.spec b/python-mkdocs-material-extensions.spec new file mode 100644 index 0000000..67c8966 --- /dev/null +++ b/python-mkdocs-material-extensions.spec @@ -0,0 +1,393 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mkdocs-material-extensions +Version: 1.1.1 +Release: 1 +Summary: Extension pack for Python Markdown and MkDocs Material. +License: MIT License +URL: https://github.com/facelessuser/mkdocs-material-extensions +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/cd/3f/e5e3c9bfbb42e4cb661f71bcec787ae6bdf4a161b8c4bb68fd7d991c436c/mkdocs_material_extensions-1.1.1.tar.gz +BuildArch: noarch + + +%description +[![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 + +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 +`:animals-bird:`. Notice that the base folder that is provided doesn't contribute to the icon's name. Also, folders +are separated with `-`. Folder names and icon names should be compatible with the emoji syntax, so special characters +should be avoided -- `-` and `_` are okay. + +You can provide as many paths as you would like, and they will be evaluated in the order that they are specified. The +Material theme's own icons will be evaluated after all custom paths. This allows a user to override Material's icons if +desired. + +If an icon name is already in the index, the icon will not be added. It is recommended to always have your icons in +sub-folders to help namespace them to avoid name collisions. In the example above, `bird` was under `animals` which +created the name `:animals-bird:` and helped create a more unique name with less of a chance of creating a duplicate +name with existing emoji and Material icons. + +[emoji]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/ +[emoji-index]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-indexes +[emoji-generator]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-generators +[mkdocs-material]: https://github.com/squidfunk/mkdocs-material + +[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal +[donate-link]: https://www.paypal.me/facelessuser +[github-ci-image]: https://github.com/facelessuser/mkdocs-material-extensions/workflows/build/badge.svg?branch=master&event=push +[github-ci-link]: https://github.com/facelessuser/mkdocs-material-extensions/actions?query=workflow%3Abuild+branch%3Amaster +[discord-image]: https://img.shields.io/discord/678289859768745989?logo=discord&logoColor=aaaaaa&color=mediumpurple&labelColor=333333 +[discord-link]: https://discord.gg/TWs8Tgr +[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/mkdocs-material-extensions/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333 +[codecov-link]: https://codecov.io/github/facelessuser/mkdocs-material-extensions +[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material-extensions.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333 +[pypi-link]: https://pypi.python.org/pypi/mkdocs-material-extensions +[python-image]: https://img.shields.io/pypi/pyversions/mkdocs-material-extensions?logo=python&logoColor=aaaaaa&labelColor=333333 +[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333 + + +%package -n python3-mkdocs-material-extensions +Summary: Extension pack for Python Markdown and MkDocs Material. +Provides: python-mkdocs-material-extensions +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mkdocs-material-extensions +[![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 + +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 +`:animals-bird:`. Notice that the base folder that is provided doesn't contribute to the icon's name. Also, folders +are separated with `-`. Folder names and icon names should be compatible with the emoji syntax, so special characters +should be avoided -- `-` and `_` are okay. + +You can provide as many paths as you would like, and they will be evaluated in the order that they are specified. The +Material theme's own icons will be evaluated after all custom paths. This allows a user to override Material's icons if +desired. + +If an icon name is already in the index, the icon will not be added. It is recommended to always have your icons in +sub-folders to help namespace them to avoid name collisions. In the example above, `bird` was under `animals` which +created the name `:animals-bird:` and helped create a more unique name with less of a chance of creating a duplicate +name with existing emoji and Material icons. + +[emoji]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/ +[emoji-index]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-indexes +[emoji-generator]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-generators +[mkdocs-material]: https://github.com/squidfunk/mkdocs-material + +[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal +[donate-link]: https://www.paypal.me/facelessuser +[github-ci-image]: https://github.com/facelessuser/mkdocs-material-extensions/workflows/build/badge.svg?branch=master&event=push +[github-ci-link]: https://github.com/facelessuser/mkdocs-material-extensions/actions?query=workflow%3Abuild+branch%3Amaster +[discord-image]: https://img.shields.io/discord/678289859768745989?logo=discord&logoColor=aaaaaa&color=mediumpurple&labelColor=333333 +[discord-link]: https://discord.gg/TWs8Tgr +[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/mkdocs-material-extensions/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333 +[codecov-link]: https://codecov.io/github/facelessuser/mkdocs-material-extensions +[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material-extensions.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333 +[pypi-link]: https://pypi.python.org/pypi/mkdocs-material-extensions +[python-image]: https://img.shields.io/pypi/pyversions/mkdocs-material-extensions?logo=python&logoColor=aaaaaa&labelColor=333333 +[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333 + + +%package help +Summary: Development documents and examples for mkdocs-material-extensions +Provides: python3-mkdocs-material-extensions-doc +%description help +[![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 + +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 +`:animals-bird:`. Notice that the base folder that is provided doesn't contribute to the icon's name. Also, folders +are separated with `-`. Folder names and icon names should be compatible with the emoji syntax, so special characters +should be avoided -- `-` and `_` are okay. + +You can provide as many paths as you would like, and they will be evaluated in the order that they are specified. The +Material theme's own icons will be evaluated after all custom paths. This allows a user to override Material's icons if +desired. + +If an icon name is already in the index, the icon will not be added. It is recommended to always have your icons in +sub-folders to help namespace them to avoid name collisions. In the example above, `bird` was under `animals` which +created the name `:animals-bird:` and helped create a more unique name with less of a chance of creating a duplicate +name with existing emoji and Material icons. + +[emoji]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/ +[emoji-index]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-indexes +[emoji-generator]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#custom-emoji-generators +[mkdocs-material]: https://github.com/squidfunk/mkdocs-material + +[donate-image]: https://img.shields.io/badge/Donate-PayPal-3fabd1?logo=paypal +[donate-link]: https://www.paypal.me/facelessuser +[github-ci-image]: https://github.com/facelessuser/mkdocs-material-extensions/workflows/build/badge.svg?branch=master&event=push +[github-ci-link]: https://github.com/facelessuser/mkdocs-material-extensions/actions?query=workflow%3Abuild+branch%3Amaster +[discord-image]: https://img.shields.io/discord/678289859768745989?logo=discord&logoColor=aaaaaa&color=mediumpurple&labelColor=333333 +[discord-link]: https://discord.gg/TWs8Tgr +[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/mkdocs-material-extensions/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333 +[codecov-link]: https://codecov.io/github/facelessuser/mkdocs-material-extensions +[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material-extensions.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333 +[pypi-link]: https://pypi.python.org/pypi/mkdocs-material-extensions +[python-image]: https://img.shields.io/pypi/pyversions/mkdocs-material-extensions?logo=python&logoColor=aaaaaa&labelColor=333333 +[license-image-mit]: https://img.shields.io/badge/license-MIT-blue.svg?labelColor=333333 + + +%prep +%autosetup -n mkdocs-material-extensions-1.1.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mkdocs-material-extensions -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.1-1 +- Package Spec generated @@ -0,0 +1 @@ +af80b5a902fae94b3b3fa3d6fa43b416 mkdocs_material_extensions-1.1.1.tar.gz |