Skip to main content

A MkDocs plugin that converts text between triple dashes to HR elements

Project description

MkDocs HR Plugin

一个用于在 MkDocs 中创建带样式分隔线的插件。可以将 ---文字--- 格式的文本转换为带有居中文字的分隔线,并在目录中优雅显示。

特性

  • ✨ 将 ---文字--- 格式转换为带样式的分隔线
  • 📑 在目录中以加粗居中的方式显示分隔线文字
  • 🌓 自动适配亮色/暗色主题
  • 🎨 分隔线样式美观,粗细和间距适中
  • 🚀 简单易用,无需配置

安装

pip install mkdocs-hr-plugin

使用方法

1.在 mkdocs.yml 中启用插件:

plugins:
  - upgradehr

2.效果展示

image.png

image.png

LICENSE

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_hr_plugin-0.1.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_hr_plugin-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_hr_plugin-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_hr_plugin-0.1.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for mkdocs_hr_plugin-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9069046cb8d0db314ddc8996adbe87c6e76edd5422a18a8841c0d71165774e75
MD5 fbbcb9cd2267d766fb90a1e01be16ba1
BLAKE2b-256 e8a9525420b67b02a94894e91382c1ba8a5547f841dab42420b9279cd6172e9b

See more details on using hashes here.

File details

Details for the file mkdocs_hr_plugin-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_hr_plugin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 136049f7782c81a5e000862895316b4ff106f95d75b14abe3b909da631dc18d4
MD5 51680e8c63c5f3219d381c3e02e22020
BLAKE2b-256 559589394b69aac9c876849b0a8d3dfd6b05af689a71634e94e66a1b7b1061dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page