feat: add documentation and changelog viewing features

astrbot/dashboard/routes/plugin.py

@@ -737,8 +737,26 @@ async def on_plugin(self):
 
     async def get_plugin_readme(self):
         plugin_name = request.args.get("name")
-        logger.debug(f"正在获取插件 {plugin_name} 的README文件内容")
+        repo_url = request.args.get("repo")
+        logger.debug(f"正在获取插件 {plugin_name} 的README文件内容, repo: {repo_url}")
 
+        # 如果提供了 repo_url，优先从远程获取
+        if repo_url:
+            try:
+                readme_content = await self._fetch_remote_readme(repo_url)
+                if readme_content:
+                    return (
+                        Response()
+                        .ok({"content": readme_content}, "成功获取README内容")
+                        .__dict__
+                    )
+                else:
+                    return Response().error("无法从远程仓库获取README文件").__dict__
+            except Exception as e:
+                logger.error(f"从远程获取README失败: {traceback.format_exc()}")
+                return Response().error(f"获取README失败: {e!s}").__dict__
+
+        # 否则从本地获取
         if not plugin_name:
             logger.warning("插件名称为空")
             return Response().error("插件名称不能为空").__dict__
@@ -791,6 +809,57 @@ async def get_plugin_readme(self):
             logger.error(f"/api/plugin/readme: {traceback.format_exc()}")
             return Response().error(f"读取README文件失败: {e!s}").__dict__
 
+    async def _fetch_remote_readme(self, repo_url: str) -> str | None:
+        """从远程GitHub仓库获取README内容"""
+        # 解析GitHub仓库URL
+        # 支持格式: https://github.com/owner/repo 或 https://github.com/owner/repo.git
+        repo_url = repo_url.rstrip("/").replace(".git", "")
+
+        # 提取 owner 和 repo
+        parts = repo_url.split("/")
+        if len(parts) < 2:
+            return None
+
+        owner = parts[-2]
+        repo = parts[-1]
+
+        # 尝试多种README文件名
+        readme_names = ["README.md", "readme.md", "README.MD", "Readme.md"]
+
+        ssl_context = ssl.create_default_context(cafile=certifi.where())
+        connector = aiohttp.TCPConnector(ssl=ssl_context)
+
+        async with aiohttp.ClientSession(
+            trust_env=True,
+            connector=connector,
+        ) as session:
+            for readme_name in readme_names:
+                # 使用GitHub raw content URL
+                raw_url = f"https://raw.githubusercontent.com/{owner}/{repo}/main/{readme_name}"
+                try:
+                    async with session.get(raw_url) as response:
+                        if response.status == 200:
+                            content = await response.text()
+                            logger.debug(f"成功从 {raw_url} 获取README")
+                            return content
+                except Exception as e:
+                    logger.debug(f"从 {raw_url} 获取失败: {e}")
+                    continue
+
+                # 尝试 master 分支
+                raw_url = f"https://raw.githubusercontent.com/{owner}/{repo}/master/{readme_name}"
+                try:
+                    async with session.get(raw_url) as response:
+                        if response.status == 200:
+                            content = await response.text()
+                            logger.debug(f"成功从 {raw_url} 获取README")
+                            return content
+                except Exception as e:
+                    logger.debug(f"从 {raw_url} 获取失败: {e}")
+                    continue
+
+        return None
+
     async def get_plugin_changelog(self):
         """获取插件更新日志
 

dashboard/src/components/extension/MarketPluginCard.vue

@@ -20,7 +20,7 @@ const props = defineProps({
   },
 });
 
-const emit = defineEmits(["install"]);
+const emit = defineEmits(["install", "viewReadme"]);
 
 const normalizePlatformList = (platforms) => {
   if (!Array.isArray(platforms)) return [];
@@ -35,6 +35,10 @@ const handleInstall = (plugin) => {
   emit("install", plugin);
 };
 
+const handleViewReadme = (plugin) => {
+  emit("viewReadme", plugin);
+};
+
 </script>
 
 <template>
@@ -198,6 +202,18 @@ const handleInstall = (plugin) => {
         </v-list>
       </v-menu>
       <v-spacer></v-spacer>
+      <v-btn
+        v-if="plugin?.repo"
+        color="info"
+        size="small"
+        variant="tonal"
+        class="market-action-btn"
+        @click="handleViewReadme(plugin)"
+        style="height: 32px"
+      >
+        <v-icon icon="mdi-file-document-outline" start size="small"></v-icon>
+        {{ tm("buttons.viewDocs") }}
+      </v-btn>
       <v-btn
         v-if="plugin?.repo"
         color="secondary"

dashboard/src/components/shared/ExtensionCard.vue

@@ -462,6 +462,10 @@ const viewChangelog = () => {
             }}</v-list-item-title>
           </v-list-item>
 
+          <v-list-item class="styled-menu-item" prepend-icon="mdi-file-document-edit-outline" @click="viewChangelog">
+            <v-list-item-title>{{ tm("buttons.viewChangelog") }}</v-list-item-title>
+          </v-list-item>
+
           <v-list-item class="styled-menu-item" prepend-icon="mdi-delete" @click="uninstallExtension">
             <v-list-item-title class="text-error">{{ tm("card.actions.uninstallPlugin") }}</v-list-item-title>
           </v-list-item>

dashboard/src/components/shared/ReadmeDialog.vue

@@ -239,7 +239,7 @@ const requiresPluginName = computed(
 );
 
 async function fetchContent() {
-  if (requiresPluginName.value && !props.pluginName) return;
+  if (requiresPluginName.value && !props.pluginName && !props.repoUrl) return;
   const requestId = ++lastRequestId.value;
   loading.value = true;
   content.value = null;
@@ -250,6 +250,10 @@ async function fetchContent() {
     let params;
     if (requiresPluginName.value) {
       params = { name: props.pluginName };
+      // 如果提供了 repoUrl，优先使用远程获取
+      if (props.repoUrl) {
+        params.repo = props.repoUrl;
+      }
     } else if (props.mode === "first-notice") {
       params = { locale: locale.value };
     }
@@ -270,10 +274,10 @@ async function fetchContent() {
 }
 
 watch(
-  [() => props.show, () => props.pluginName, () => props.mode],
+  [() => props.show, () => props.pluginName, () => props.mode, () => props.repoUrl],
   ([show, name]) => {
     if (!show) return;
-    if (requiresPluginName.value && !name) return;
+    if (requiresPluginName.value && !name && !props.repoUrl) return;
     fetchContent();
   },
   { immediate: true },

dashboard/src/i18n/locales/en-US/features/extension.json

@@ -43,6 +43,7 @@
     "viewInfo": "Handlers",
     "viewDocs": "Documentation",
     "viewRepo": "Repository",
+    "viewChangelog": "View Changelog",
     "close": "Close",
     "save": "Save",
     "saveAndClose": "Save and Close",

dashboard/src/i18n/locales/ru-RU/features/extension.json

@@ -1,4 +1,4 @@
-{
+{
     "title": "Плагины",
     "subtitle": "Управление и настройка расширений системы",
     "tabs": {
@@ -43,6 +43,7 @@
         "viewInfo": "Детали",
         "viewDocs": "Документация",
         "viewRepo": "Репозиторий",
+        "viewChangelog": "Смотреть журнал изменений",
         "close": "Закрыть",
         "save": "Сохранить",
         "saveAndClose": "Сохранить и закрыть",

dashboard/src/i18n/locales/zh-CN/features/extension.json

@@ -44,6 +44,7 @@
     "viewInfo": "行为",
     "viewDocs": "文档",
     "viewRepo": "仓库",
+    "viewChangelog": "查看更新日志",
     "close": "关闭",
     "save": "保存",
     "saveAndClose": "保存并关闭",

dashboard/src/views/extension/InstalledPluginsTab.vue

@@ -705,6 +705,14 @@ const pinnedPlugins = computed(() => {
                             <v-list-item-title>{{ tm("buttons.update") }}</v-list-item-title>
                           </v-list-item>
 
+                          <v-list-item
+                            class="styled-menu-item"
+                            prepend-icon="mdi-file-document-edit-outline"
+                            @click="viewChangelog(item)"
+                          >
+                            <v-list-item-title>{{ tm("buttons.viewChangelog") }}</v-list-item-title>
+                          </v-list-item>
+
                           <v-list-item
                             class="styled-menu-item"
                             prepend-icon="mdi-delete"

dashboard/src/views/extension/MarketPluginsTab.vue

@@ -347,6 +347,7 @@ const marketCategorySelectItems = computed(() =>
                     :default-plugin-icon="defaultPluginIcon"
                     :show-plugin-full-name="showPluginFullName"
                     @install="handleInstallPlugin"
+                    @view-readme="viewReadme"
                   />
                 </v-col>
               </v-row>
@@ -397,6 +398,7 @@ const marketCategorySelectItems = computed(() =>
                         :default-plugin-icon="defaultPluginIcon"
                         :show-plugin-full-name="showPluginFullName"
                         @install="handleInstallPlugin"
+                        @view-readme="viewReadme"
                       />
                     </v-col>
                   </v-row>