mkdocs-hr-plugin 0.1.1

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

MkDocs HR Plugin

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

✨ 特性

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

🚀 安装

pip install mkdocs-hr-plugin

📖 使用方法

在mkdocs.yml中启用插件

plugins:
  - upgradehr

🎨 效果展示

正文

目录

🔧 配置选项

目前插件不需要任何配置，开箱即用。未来可能会添加以下配置选项：

• 自定义分隔线样式
• 自定义文字样式
• 更多主题适配

🤝 贡献指南

欢迎提交 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 文件了解详情

🙏 致谢

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

📮 联系方式

• 作者：amaranth
• 邮箱：[e-mail]
• GitHub：Auzers

⭐ 支持项目

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