xixu-me/xget
1
0 Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

[FEATURE] 文档太长了，而且没有目录，不方便快速检索内容 #9

New Issue
Closed
opened 2026-10-07 21:20:57 +00:00 by xixu-me · 2 comments
xixu-me commented 2026-10-07 21:20:57 +00:00
Owner
Copy link
Copy source

问题描述

文档太长了，而且没有目录，不方便快速检索内容。大家找到这个库的时候往往是带着明确目的来的，比如docker加速、npm加速，但是这些内容隐藏在太长的文档中了，很不方便。

解决方案描述

可以考虑将文档拆分为多个小文档，readme中仅保留文档标题与连接，这样不同需求的人们可以快速找到自己感兴趣的内容

功能类别

性能优化

优先级

低 - 有了更好

替代方案

No response

使用场景

快速检索内容

实现想法

No response

涉及平台

No response

附加信息

No response

确认

  • 我已经搜索了现有的 issues，确认这不是重复请求
  • 我已经阅读了存储库文档，确认此功能尚未存在
  • 这个功能符合存储库的目标和范围

GitHub 来源：https://github.com/xixu-me/xget/issues/52
作者：yeqiugt · 创建时间：2025-09-05T07:29:30Z

### 问题描述 文档太长了，而且没有目录，不方便快速检索内容。大家找到这个库的时候往往是带着明确目的来的，比如docker加速、npm加速，但是这些内容隐藏在太长的文档中了，很不方便。 ### 解决方案描述 可以考虑将文档拆分为多个小文档，readme中仅保留文档标题与连接，这样不同需求的人们可以快速找到自己感兴趣的内容 ### 功能类别 性能优化 ### 优先级 低 - 有了更好 ### 替代方案 _No response_ ### 使用场景 快速检索内容 ### 实现想法 _No response_ ### 涉及平台 _No response_ ### 附加信息 _No response_ ### 确认 - [x] 我已经搜索了现有的 issues，确认这不是重复请求 - [x] 我已经阅读了存储库文档，确认此功能尚未存在 - [x] 这个功能符合存储库的目标和范围 --- GitHub 来源：https://github.com/xixu-me/xget/issues/52 作者：yeqiugt · 创建时间：2025-09-05T07:29:30Z <!-- github-archive:3386571358 -->
xixu-me added the enhancement label 2026-10-07 21:20:57 +00:00
xixu-me commented 2026-10-07 21:20:58 +00:00
Author
Owner
Copy link
Copy source

可以将 README 文档开头的徽章（超链接）组作为目录

GitHub 来源：https://github.com/xixu-me/xget/issues/52#issuecomment-3257376277
作者：xixu-me · 创建时间：2025-09-05T07:35:57Z

可以将 README 文档开头的徽章（超链接）组作为目录 --- GitHub 来源：https://github.com/xixu-me/xget/issues/52#issuecomment-3257376277 作者：xixu-me · 创建时间：2025-09-05T07:35:57Z <!-- github-archive:3257376277 -->
xixu-me commented 2026-10-07 21:20:58 +00:00
Author
Owner
Copy link
Copy source

点击右上角Outline会打开目录：

Image

GitHub 来源：https://github.com/xixu-me/xget/issues/52#issuecomment-3839304871
作者：eryajf · 创建时间：2026-02-03T06:20:16Z

点击右上角`Outline`会打开目录： <img width="1823" height="1137" alt="Image" src="https://github.com/user-attachments/assets/812972e6-a203-4348-ad42-89ec53d2e86f" /> --- GitHub 来源：https://github.com/xixu-me/xget/issues/52#issuecomment-3839304871 作者：eryajf · 创建时间：2026-02-03T06:20:16Z <!-- github-archive:3839304871 -->
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
bug
Something isn't working
 dependencies
Pull requests that update a dependency file
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 javascript
Pull requests that update Javascript code
 npm
question
Further information is requested
 wontfix
This will not be worked on
No labels enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
xixu-me (Xi Xu)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: xixu-me/xget#9