DSH Plugins
返回列表
⚙️

dsh-readme

工作流 更新于 2026.08.19

在终端中运行以下命令:

dsh plugin install uckkk/dsh-readme

将以下提示词粘贴到 DeepSeek Harness 对话框中:

在 DeepSeek Harness 中执行 dsh plugin install uckkk/dsh-readme 完成安装,插件开源源码地址为 https://github.com/uckkk/dsh-readme 。

插件介绍

新项目搭好脚手架,打开仓库首页却发现 README 还是模板里那三行占位文字。写起来没头绪——该放哪些段落、技术栈怎么罗列、项目结构树从何而来,一个个问题堵在那里,最终多半是先跳过再说。dsh-readme 就是为这一刻准备的:一条命令,把骨架先立起来,让你不再对着空白文件发呆。

它的核心思路简单直接:纯 Node 在本地扫描 package.json、目录结构、npm scripts 和许可证信息,从依赖中自动识别技术栈(React、Vue、Next.js、Vite、Express、NestJS、TypeScript、Tailwind 等),然后输出一份包含标题、项目描述、技术栈、安装步骤、使用示例、目录结构树和许可证声明的结构化 README.md 骨架。整个过程不发起任何网络请求、不依赖外部服务,在本地静默完成。生成的是骨架而非终稿,具体的功能特性描述、API 说明、截图占位等留给你在生成之后补充润色,既省去了从零排版的力气,又保留了自定义的空间。

适合的场景很清晰:独立开发者快速给新仓库一个体面的第一印象;团队在初始化新项目时统一 README 起点,减少格式分歧;或者你只是想把一份半成品项目的结构信息一次性整理出来,再慢慢填充细节。不需要记住该写哪些段落,不需要复制粘贴模板,扫一次,骨架就位,接下来只专注内容本身。

使用场景

  • 新项目脚手架搭好后快速生成 README 骨架
  • 从 package.json 依赖中自动识别技术栈并写入文档
  • 将目录结构树与 npm scripts 一次性整理进 README

适合人员

  • 需要给新仓库一个体面第一印象的独立开发者
  • 希望团队统一 README 起点格式的负责人
  • 想把半成品项目结构信息一次性整理出来的开发者