dsh-readme
文件与数据 活跃维护

dsh-readme

uckkk/dsh-readme

可自动扫描项目技术栈、目录结构与脚本内容,快速生成规范的结构化README.md文件,无需手动整理项目基础信息,轻量易用,有效降低项目文档编写的时间成本。

0
Stars 标星
0
Forks 分支
0
Watchers 关注
0
Open Issues
JavaScript
主要语言
MIT
开源协议
6 KB
仓库大小
1 个月前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:uckkk/dsh-readme
git clone https://github.com/uckkk/dsh-readme.git
git clone git@github.com:uckkk/dsh-readme.git
README.md main

dsh-readme · README 生成

扫描项目(package.json、目录结构、技术栈、npm scripts、许可证),自动生成一份结构化的 README.md。纯 Node 实现,无网络、无外部服务。

提供的工具

工具 作用
generate_readme 扫描项目并生成 README.md(标题、描述、技术栈、安装、使用、项目结构、许可证)

安装

dsh plugin add dsh-readme

安装后在 profile 的 package.json 的 dsh.profile.bundles 中加入 "dsh-readme"。

用法示例

帮我给这个项目生成一份 README
→ 调用 generate_readme(root="/workspace")

说明

  • 技术栈从依赖自动识别(React/Vue/Next/Vite/Express/NestJS/TypeScript/Tailwind 等)。
  • 生成的是结构化骨架(含项目结构树、scripts),具体功能特性、API 说明等可生成后再补充润色。

安装

dsh plugin add github:uckkk/dsh-readme

安装即在本机运行第三方代码,请自行审阅源码。

安装

dsh plugin add github:uckkk/dsh-readme

使用

安装后在会话中调用该插件注册的工具即可。

许可

MIT

安装即在本机运行第三方代码,请自行审阅源码。