Metadata-Version: 2.4
Name: mkdocs-hr-plugin
Version: 0.1.0
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 中创建带样式分隔线的插件。可以将 `---文字---` 格式的文本转换为带有居中文字的分隔线，并在目录中优雅显示。

## 特性

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

## 安装

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

## 使用方法

1.在 `mkdocs.yml` 中启用插件：

```yaml
plugins:
  - upgradehr
```

2.效果展示

![image.png](https://cdn.jsdelivr.net/gh/Auzers/drawingbed/image/20250320110448217.png)

![image.png](https://cdn.jsdelivr.net/gh/Auzers/drawingbed/image/20250320110507583.png)

## LICENSE

[MIT](LICENSE)
