插件 README.md 说明

插件支持在根目录放置 README.md 文件，用于编写插件的使用说明文档。该文件内容会被系统自动读取并展示在插件编辑页面，方便开发者为用户提供操作指南等内容。

提示

此功能在 beikeshop v3.0.0.4 版本 和 beikeshop v2.0.0.27 以上生效。

功能说明

当插件根目录存在 README.md 文件时，系统会自动解析其内容，并在后台插件管理页面的编辑区域展示：

效果示例

下图展示了带有 README.md 文件的插件在编辑页面中的显示效果：

使用方式

1. 在插件根目录创建 README.md 文件
2. 使用 Markdown 语法编写插件的使用说明
3. 支持标准 Markdown 格式，包括标题、列表、代码块、链接等

示例内容

# 插件名称

这是一个功能插件的使用说明。

## 功能特性

- 功能一：介绍
- 功能二：介绍
- 功能三：介绍

## 使用方法

1. 第一步
2. 第二步
3. 第三步

## 注意事项

- 注意事项一
- 注意事项二

注意事项

• README.md 文件必须放在插件根目录
• 文件名必须为 README.md（区分大小写）
• 建议控制内容长度，过长的文档可能会影响页面布局
• 支持 Markdown 语法，但复杂的 HTML 可能无法正常渲染