V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
Azad01
V2EX  ›  分享创造

一个小工具用于生成 Github 仓库目录树 & 分享卡片

  •  
  •   Azad01 · 19 天前 · 884 次点击

    GitTree 是什么?

    一个免费的网页小工具(也提供 油猴脚本)。

    它的核心能力是:输入一个 GitHub 仓库的网址,它就能立刻为你 生成一份清晰、美观的 目录树视图 与 多种风格化的 GitHub 项目分享卡片 。

    项目开源地址:Azad-sl/GitTree,以下卡片由 GitTree 生成:

    Github 地址

    Github 地址

    Gitee 备份-上面的 Github 地址打不开可以访问这个

    Gitee 备份-上面的 Github 地址打不开可以访问这个

    GitTree 目录树

    GitTree 生成的 mac 风格目录树图片

    • 数据准确可靠: 它直接与 GitHub 官方“对话”(使用其公开的 API ),获取的数据和你在 GitHub 网页上看到的目录结构完全同步、真实准确。

    • 操作简单直观: 没有复杂的配置,打开网页或启用插件,粘贴链接即可。

    新手老手都省心

    你是否也遇到过这些情况?

    • 初探 GitHub: 打开一个热门的开源项目,面对层层叠叠的文件夹,感觉像走进迷宫,不知从何看起?

    • 写文档头疼: 想在 README 或博客里展示自己项目的目录结构,手动编写既费时又容易出错,截图排版又不够美观专业。

    • 分享不直观: 给朋友分享一个仓库,只说“代码在这里”,对方可能还是一头雾水,不清楚项目是如何组织的。

    • 搭建本地框架: 想照着线上仓库的结构在本地创建空文件夹,一个个 mkdir 敲命令太慢,容易遗漏。

    GitTree 正是为了解决这些痛点而设计的工具。 它的目标很简单:让任何公开 GitHub 仓库的目录结构,都能被快速、清晰、优雅地呈现出来。 无论你是刚接触 GitHub 的新朋友,还是经验丰富的开发者,它都能帮你节省时间,提升效率。

    为什么 GitTree 值得一试?

    1. ⚡一秒看清项目布局 (尤其适合新手!):
    • 面对陌生项目不再迷茫。输入链接,目录树瞬间展开,项目的骨架一目了然。

    • 快速了解项目的核心模块和文件组织方式,找到你关心的部分。

    1. 🧾完美嵌入文档 (告别手敲和丑陋截图):
    • 写 README 、项目文档或技术博客? GitTree 可以生成格式工整的纯文本或标准的 Markdown 代码块。复制粘贴,结构清晰又专业。

    • 需要更直观的分享?直接 导出为一张精美的图片(带 macOS 风格窗口),贴到哪里都好看。

    1. 🤝优雅地分享项目结构:
    • 想向别人介绍一个仓库的组织方式?发送 GitTree 生成的目录树(文本、Markdown 或图片),比单纯丢个链接清晰百倍。

    • 还支持生成 多种风格化的 GitHub 项目卡片,清晰展示项目简介、star 、fork 、主要编程语言以及二维码链接,分享更吸睛。

    1. 💻快速搭建本地目录 (提升效率):
    • 需要在 本地创建一个和线上仓库 一模一样的空文件夹结构? GitTree 可以一键生成脚本!

    • Windows 用户: 获取 .bat 批处理文件,双击运行即可创建。

    • macOS/Linux 用户: 获取 .sh Shell 脚本,在终端执行即可创建。省去手动创建的麻烦,准确无误。

    人性化的细节体验:

    • 按需查看:

    • depth: 控制显示几层深度,避免信息过载。

    • exclude: 过滤掉不想看的文件/文件夹(如 *.lognode_modules),支持通配符 *

    • View Mode: 切换显示完整文件列表仅文件夹结构

    • 舒适阅读: 支持亮色/暗色主题,保护你的眼睛。

    • 语言无忧: 首次访问会自动匹配你的浏览器语言(中文/英文),并且会记住你的选择。

    • 两种使用方式,随你喜欢:

    • 在线网页版 (最简单): 打开即用,无需安装 -> https://azad-sl.github.io/GitTree

    • 油猴脚本 (更便捷): 安装后,在浏览任何 GitHub 仓库页面时,页面上会出现一个额外按钮,点击即可直接为该仓库生成目录树! -> 脚本地址:https://openuserjs.org/scripts/Azad-sl/GitHub_Repo_Tree_Generator

    安装脚本后右上角将显示脚本按钮

    安装脚本后右上角将显示脚本按钮

    GitTree 适合谁?

    • GitHub 新手: 快速理解项目结构的利器。

    • 开源贡献者/维护者: 编写、更新、分享项目的好帮手。

    • 技术博主/讲师: 清晰展示代码结构的必备工具。

    • 任何需要高效处理 GitHub 目录结构的开发者: 节省时间,专注核心开发。

    开源共享,欢迎参与!

    • 如果觉得有帮助,可以给项目点个 Star⭐ ,或者请作者喝杯咖啡☕ 。

    希望 GitTree 能成为你探索和分享 GitHub 世界的一个实用小助手!

    other

    在国内 Gitee 平台上也开源了功能一样的项目,** 为 Gitee 仓库服务,暂命名为 GiteeTree **,下面这个卡片还有上面那个 GitTree 备份卡片就是用它做的,同样设计了四种项目卡片风格(以下四个二维码扫描任何一个即可):

    GiteeTree 开源地址 - MAC 风格

    GiteeTree 开源地址 - Mac 风格

    GiteeTree 开源地址 - Material 风格

    GiteeTree 开源地址 - Material 风格

    GiteeTree 开源地址 - Gitee 风格

    GiteeTree 开源地址 - Gitee 风格

    GiteeTree 开源地址 - 现代风格

    GiteeTree 开源地址 - 现代风格



    目前尚无回复
    关于   ·   帮助文档   ·   自助推广系统   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2808 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 18ms · UTC 08:14 · PVG 16:14 · LAX 01:14 · JFK 04:14
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.