Metadata-Version: 2.4
Name: mkdocs-hr-plugin
Version: 0.1.1
Summary: A MkDocs plugin that converts text between triple dashes to HR elements
Home-page: https://github.com/Auzers/mkdocs-hr-plugin
Author: amaranth
Author-email: amaranth <amaranth2082@gmail.com>
Project-URL: Homepage, https://github.com/Auzers/mkdocs-hr-plugin
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: mkdocs>=1.0.0
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

# MkDocs HR Plugin

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

[![PyPI version](https://badge.fury.io/py/mkdocs-hr-plugin.svg)](https://badge.fury.io/py/mkdocs-hr-plugin)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## ✨ 特性

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

## 🚀 安装

```bash
pip install mkdocs-hr-plugin
```

## 📖 使用方法

在mkdocs.yml中启用插件

```yaml
plugins:
  - upgradehr
```



## 🎨 效果展示

<div align="center">
  <p><strong>正文</strong></p>
  <img src="https://cdn.jsdelivr.net/gh/Auzers/drawingbed/image/20250320110448217.png" 
       width="400" 
       style="max-width: 100%; 
              border-radius: 6px; 
              box-shadow: 0 2px 6px rgba(0,0,0,0.1);" 
       alt="正文">
  
  <p><strong>目录</strong></p>
  <img src="https://cdn.jsdelivr.net/gh/Auzers/drawingbed/image/20250320110507583.png" 
       width="400" 
       style="max-width: 100%; 
              border-radius: 6px; 
              box-shadow: 0 2px 6px rgba(0,0,0,0.1);" 
       alt="目录">
</div>

## 🔧 配置选项

目前插件不需要任何配置，开箱即用。未来可能会添加以下配置选项：
- 自定义分隔线样式
- 自定义文字样式
- 更多主题适配

## 🤝 贡献指南

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的改动 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启一个 Pull Request

## 📝 更新日志

### 0.1.0 (2024-03-20)
- 初始版本发布
- 基本功能实现

## 📄 许可证

本项目基于 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 🙏 致谢

- MkDocs 团队提供的优秀文档工具
- 所有贡献者和用户

## 📮 联系方式

- 作者：amaranth
- 邮箱：amaranth2082@gmail.com
- GitHub：[Auzers](https://github.com/Auzers)

## ⭐ 支持项目

如果这个项目对你有帮助，欢迎star 
