LOADING...
Readme-tree 是一个利用 GitHub Actions 在代码提交时自动为 README 文档添加项目树状文件图的开源工具。它可以直观地展示仓库的文件层次结构，解决项目结构展示不清的问题，并支持显示文件大小、相对路径以及隐藏特定目录（如 .git）等自定义设置。文章详细介绍了该工具的快速部署步骤、详细参数配置方法以及如何使用配套的撤销组件来移除生成的树状图。
让别人一眼就能知道你的项目结构确实是件难事，能不能像在终端里输入tree那样就直接展示项目的文件层次呢？于是我在几年前就开发了readme-tree，这里来介绍一下。
image.png
注:以下效果可组合使用
1.将以下代码加入需要添加readme-tree功能的仓库的README.md:(位置可自定义)
2.在仓库中创建一个actions文件，路径为:.github/workflows/[这里填写一个名字].yml，内容如下:
(若不希望仓库贡献者中出现github-action-user，也可以将上述代码中的actions@github.com与github-actions替换为自己的github邮箱及昵称。)
3.大功告成!如果上述操作顺利完成，每次对仓库进行push后都会触发自动生成。若未出现，请检查仓库的Actions功能是否开启、Actions的令牌(Settings>Actions>General>Workflow permissions)是否设置为读写。
| 功能名 | 描述 | 可选值 | 默认值 |
|---|---|---|---|
| showall | 是否展示所有文件及目录 | yes/no | yes |
| showdirectoryname | 仅展示文件夹名 | yes/no | no |
| showchangetime | 显示更改时间(废弃参数，不可用) | - | no |
| showsize | 以字节为单位，显示文件大小 | yes/no | no |
| showallname | 显示相对路径 | yes/no | no |
| ignoregit | 隐藏.git文件 | yes/no | yes |
要想单独打开/关闭这些功能，仅需在仓库的yml文件中以with的方式更改。
例如，若希望显示文件大小并显示相对路径，并且关闭对.git文件的隐藏，只需这样写:
若内容过长，可以在markdown标签中使用 标签隐藏。 用法如下:
效果:
显示内容 这里放置隐藏的内容
若需要默认隐藏readme-tree，将#快速开始中提到的代码放入文字区域即可。另外，也可以默认显示，并提供隐藏功能:
效果:
显示/隐藏内容 这里的内容默认显示
只需在yml文件中这样修改，就可以清除生成的树状图：
在 readme-tree-undo 中查看详情。
若想进行版本更改，仅需修改yml配置中中@后面的版本号即可。默认为保持最新
为了防止你的repo过大导致生成的tree过长而无法清除，你可以使用readme-tree-undo来快捷删除所有tree
只需在yml文件中这样修改，就可以清除生成的树状图：
<details>RavelloH/readme-tree.
├── .github
│ └── workflows
│ └── main.yml
├── README.md
├── action.yml
├── main.py
└── tree.sh
2 directories, 5 files.
├── README.md
├── action.yml
├── main.py
├── tree.bak
└── tree.sh
0 directories, 5 files.
└── .github
└── workflows
2 directories.
├── [ 4096] .github
│ └── [ 4096] workflows
│ └── [ 591] main.yml
├── [ 1018] README.md
├── [ 4067] action.yml
├── [ 1677] main.py
├── [ 0] tree.bak
└── [ 809] tree.sh
2 directories, 6 files.
├── ./.github
│ └── ./.github/workflows
│ └── ./.github/workflows/main.yml
├── ./README.md
├── ./action.yml
├── ./main.py
├── ./tree.bak
└── ./tree.sh
2 directories, 6 files.
├── .git
│ ├── FETCH_HEAD
│ ├── HEAD
│ ├── branches
│ ├── config
│ ├── description
│ ├── hooks
│ │ ├── applypatch-msg.sample
│ │ ├── commit-msg.sample
│ │ ├── fsmonitor-watchman.sample
│ │ ├── post-update.sample
│ │ ├── pre-applypatch.sample
│ │ ├── pre-commit.sample
│ │ ├── pre-merge-commit.sample
│ │ ├── pre-push.sample
│ │ ├── pre-rebase.sample
│ │ ├── pre-receive.sample
│ │ ├── prepare-commit-msg.sample
│ │ ├── push-to-checkout.sample
│ │ └── update.sample
│ ├── index
│ ├── info
│ │ └── exclude
│ ├── logs
│ │ ├── HEAD
│ │ └── refs
│ │ ├── heads
│ │ │ └── main
│ │ └── remotes
│ │ └── origin
│ │ └── main
│ ├── objects
│ │ ├── 32
│ │ │ └── 91e7de4715c57b39dd04cda52b7fd42f9f3fb7
│ │ ├── 3c
│ │ │ └── 00233aaca2704ff5eb8b59ea5d3cb00bf4a170
│ │ ├── 61
│ │ │ └── 365f6c6bf64e9e8b5a81f2d6161b29f30e3ac0
│ │ ├── 65
│ │ │ └── f2274944ed41c8f1f3b23f62d654329e018c65
│ │ ├── 75
│ │ │ └── 8e46b40b670dd33c53758979256da27cb3cb4b
│ │ ├── 93
│ │ │ └── cb9b7c5a3a5e0e3c36152b091bf9f84f9fc60e
│ │ ├── bc
│ │ │ └── fcd82886eb8f9ae9e1c95337f6a3a12f767e8a
│ │ ├── bf
│ │ │ └── a8b87102f67ff125f87ef1b8f20eaeb2601e75
│ │ ├── cc
│ │ │ └── 0f3f0697c757e92a3fef16fa5624c2e882bf1a
│ │ ├── info
│ │ └── pack
│ ├── refs
│ │ ├── heads
│ │ │ └── main
│ │ ├── remotes
│ │ │ └── origin
│ │ │ └── main
│ │ └── tags
│ └── shallow
├── .github
│ └── workflows
│ └── main.yml
├── README.md
├── action.yml
├── main.py
├── tree.bak
└── tree.sh
28 directories, 40 files<!-- readme-tree start -->
<!-- readme-tree end -->on: [push]
jobs:
tree:
runs-on: ubuntu-latest
name: readme-tree
steps:
- uses: actions/checkout@v3
- name: Tree
uses: RavelloH/readme-tree@latest
- name: commit
continue-on-error: True
run: |
git init
git pull
git config --local user.email "actions@github.com"
git config --local user.name "github-actions"
git add .
git commit -m "[Readme-Tree]`date '+%Y-%m-%d %H:%M:%S'`" || exit
git status
git push -f#以上省略......
name: readme-tree
steps:
- uses: actions/checkout@v3
- name: Tree
uses: RavelloH/readme-tree@latest
with:
showsize: 'yes'
showallname: 'yes'
ignoregit: 'no'
- name: commit
continue-on-error: True
run: |
git init
#以下省略......<details>
<summary>显示内容</summary>
<!-- readme-tree start -->
<!-- readme-tree end -->
这里放置隐藏的内容
</details><details open>
<summary>显示/隐藏内容</summary>
<!-- readme-tree start -->
<!-- readme-tree end -->
这里的内容默认显示
</details>#Omitted above......
name: readme-tree
steps:
- uses: actions/checkout@v3
- name: Tree
- uses: RavelloH/readme-tree@latest
+ uses: RavelloH/readme-tree-undo@latest
- name: commit
continue-on-error: True
run: |
git init
#Omitted below......#Omitted above......
name: readme-tree
steps:
- uses: actions/checkout@v3
- name: Tree
- uses: RavelloH/readme-tree@latest
+ uses: RavelloH/readme-tree-undo@latest
- name: commit
continue-on-error: True
run: |
git init
#Omitted below......<!-- readme-tree start -->
-.
-├── .github
-│ └── workflows
-│ └── main.yml
-├── LICENCE
-├── README.md
-├── action.yml
-├── main.py
-├── tree.bak
-└── tree.sh
-
-2 directories, 7 files
<!-- readme-tree end -->
评论