readmeX

丢进代码库,自动生成中文 README 和可浏览 Wiki

开源 🏷️完全免费 🔧 仅开源项目,无在线服务,需自行部署 办公效率 🍴 复刻 26 🐛 待处理 10 👀 关注 2
GitHub ↗
GitHub 星标 ★ 648
维护状态 较活跃
是否开源 开源
定价模式 🏷️完全免费 开源免费,需自行部署

项目预览

readmeX 项目界面预览图
图片来源:GitHub 官方仓库名片

项目数据

分类办公效率
开发团队aibox22
定价模式🏷️完全免费
价格说明开源免费,需自行部署
访问状态🔧 仅开源项目,无在线服务,需自行部署
是否开源是
开源协议MIT
主要语言Python
技术栈/模型ai-tools,cli,documentation,gpt,llm,markdown,python,readme
GitHub 星标★ 648
上线时间2025-07-02 00:00:00
代码更新2026-10-10
仓库体积2.3 MB
本站数据更新2026-10-25
维护状态较活跃
收录时间2026-10-25
浏览次数0

项目介绍

readmeX 是一个用 Python 编写的 AI 文档生成工具,面向中文用户,定位为开源的 DeepWiki 替代方案。它读取项目源码,调用大模型自动生成 README 和可交互的 Wiki 页面,解决开源项目文档缺失、维护成本高、新贡献者上手难的问题。核心能力包括:自动分析代码结构与依赖关系,提炼模块职责与调用逻辑;生成结构化的 README,涵盖项目简介、安装、使用示例与配置说明;产出可浏览的交互式 Wiki,支持按模块跳转查阅;提供 CLI 入口,可接入本地或云端 LLM,便于在 CI 或本地一键运行。适合个人开发者、小团队在项目初期快速补齐文档,也适合中文社区为存量项目补写说明。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

数据来源:GitHub API 逐日快照 · 收录于 2026-10-25 · 当前星标 ★ 648

核心亮点

  • CLI 一键运行,读取源码后直接产出 README 与 Wiki,接入成本低
  • 面向中文输出,弥补 DeepWiki 等工具中文文档质量不足的问题
  • 生成交互式 Wiki,按模块组织内容,比单文件 README 更易浏览

不足之处

  • 早期项目,648 星,生态与稳定性仍在打磨
  • 生成质量依赖所选 LLM 与提示词,复杂项目可能出现描述偏差
  • 文档/社区待观察

适用场景

  • 开源项目初期快速补齐 README 与使用说明
  • 为存量老项目批量补写中文文档与模块 Wiki
  • 团队内部代码库自动生成上手文档,降低新人熟悉成本

替代项目

DeepWiki、GitDoc、readme-ai

上一篇:PDFeXpress

下一篇:Pulse

同类项目推荐

ServiceNowDocs 开源

官方 ServiceNow 文档,直接喂给大模型做知识库

ServiceNow AI Platform documentation for LLM consumption.

★ 537 2026-09-16
convoviz 开源

把 ChatGPT 聊天记录一键变成干净的 Markdown 和图表

Convert your ChatGPT export (ZIP) into clean Markdown text files with inline media, ···

★ 888 2026-08-09
kian 开源

一个尚在萌芽的办公效率小工具,等你来探索

Hello, I'm Kian.

★ 85 2026-08-09
LLM-Minutes-of-Meeting 开源

上传会议录音,自动出文字稿和纪要

Turn audio and video recordings into transcripts, decisions and action items. Suppor···

★ 174 2026-09-15
csv-ai-analyzer 开源

本地运行,用聊天的方式分析 CSV 数据,自动出图

A self-hosted, browser-based AI CSV analyzer

★ 87 2026-08-09
mdflux 开源

把扫描件批量变成干净 Markdown,离线省钱省 token

Turn any document into clean, AI-ready Markdown. Local-first desktop app: reads scan···

★ 569 2026-08-09
RapidDoc 开源

把复杂 PDF 一键转成 Markdown 和 JSON

A high-performance, open-source PDF data extraction tool. 一站式开源高性能数据提取···

★ 233 2026-10-24
docext 开源

无需 OCR,本地快速将文档转为 Markdown,并支持效果评测。

An on-premises, OCR-free unstructured data extraction, markdown conversion and bench···

★ 2086 2026-08-09