@@ -17,19 +17,24 @@ A powerful, pixel-perfect, single-page web application to download files or fold
1717To share a direct download link with a friend, simply add the GitHub URL after the hash (` ?= ` ):
1818
1919### Direct
20+
2021> [ https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages ] ( https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages )
2122
2223### With Name
24+
2325> [ https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages&name=react-core ] ( https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages&name=react-core )
2426
2527### Partial / Range Download
28+
2629If a repository is too large, you can limit the number of files to download using ` &st ` (Start) and ` &mx ` (Max).
30+
2731> [ https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages&st=50&mx=150 ] ( https://GitFolderDownloader.github.io/?=https://github.com/facebook/react/tree/main/packages&st=50&mx=150 )
2832
29- * ` &st=50 ` : Start downloading from the 50th file.
30- * ` &mx=150 ` : Stop downloading at the 150th file.
33+ - ` &st=50 ` : Start downloading from the 50th file.
34+ - ` &mx=150 ` : Stop downloading at the 150th file.
3135
3236When the user visits this link, the app will:
37+
33381 . Parse the URL.
34392 . Auto-fill the input and limit fields.
35403 . Immediately start fetching and zipping files ** 50 to 150** .
@@ -42,30 +47,39 @@ When the user visits this link, the app will:
42474 . Paste token. It is saved in your browser's LocalStorage and never sent to any 3rd party server.
4348
4449---
50+
4551## 🔗 API
4652
4753To embed a direct download link within your website/page, simply use this pattern. The API also supports the ` &st ` and ` &mx ` parameters.
4854
4955### Embed as a link
56+
5057``` html
5158<!-- Download all files -->
52- <a href =" https://GitFolderDownloader.github.io/api/?=https://github.com/facebook/react/tree/main/packages&name=react-core" >Download Core</a >
59+ <a
60+ href =" https://GitFolderDownloader.github.io/api/?=https://github.com/facebook/react/tree/main/packages&name=react-core"
61+ >Download Core</a
62+ >
5363
5464<!-- Download files 0 to 100 only -->
55- <a href =" https://GitFolderDownloader.github.io/api/?=https://github.com/facebook/react/tree/main/packages&name=react-core&st=0&mx=100" >Download Part 1</a >
65+ <a
66+ href =" https://GitFolderDownloader.github.io/api/?=https://github.com/facebook/react/tree/main/packages&name=react-core&st=0&mx=100"
67+ >Download Part 1</a
68+ >
5669```
5770
5871### Use via JavaScript
72+
5973``` javascript
6074function triggerDownload () {
61- const repo = " https://github.com/facebook/react/tree/main/packages" ;
62-
63- // Optional: Add limits for large folders
64- const params = " &st=0&mx=200" ;
65-
66- const apiUrl = ` https://git-zip-pro.vercel.app/api/?url=${ repo}${ params} ` ;
67-
68- window .open (apiUrl, ' _blank' );
75+ const repo = " https://github.com/facebook/react/tree/main/packages" ;
76+
77+ // Optional: Add limits for large folders
78+ const params = " &st=0&mx=200" ;
79+
80+ const apiUrl = ` https://git-zip-pro.vercel.app/api/?url=${ repo}${ params} ` ;
81+
82+ window .open (apiUrl, " _blank" );
6983}
7084```
7185
@@ -77,22 +91,22 @@ Git Folder Downloader also provides a **GitHub-integrated userscript** that adds
7791
7892### ✨ What the Userscript Does
7993
80- * Injects a ** “Download Repo / Folder / File”** action into GitHub’s context menus
81- * Automatically detects:
82- * ** Repository menu** → shows ** Download Repo**
83- * ** Folder menu** → shows ** Download Folder**
84- * ** File menu** → shows ** Download**
85- * Opens a ** GitHub-themed custom popup** to set an optional download name
86- * Auto-fills the popup with the current repo / folder / file name
87- * Fully matches GitHub light & dark themes
88- * Uses the official ** Git Folder Downloader API** under the hood
94+ - Injects a ** “Download Repo / Folder / File”** action into GitHub’s context menus
95+ - Automatically detects:
96+ - ** Repository menu** → shows ** Download Repo**
97+ - ** Folder menu** → shows ** Download Folder**
98+ - ** File menu** → shows ** Download**
99+ - Opens a ** GitHub-themed custom popup** to set an optional download name
100+ - Auto-fills the popup with the current repo / folder / file name
101+ - Fully matches GitHub light & dark themes
102+ - Uses the official ** Git Folder Downloader API** under the hood
89103
90104### 🧩 Supported Script Runners
91105
92- * Tampermonkey
93- * Violentmonkey
94- * ScriptRunner (Chromium-based extensions)
95- * Other userscript-compatible extensions
106+ - Tampermonkey
107+ - Violentmonkey
108+ - ScriptRunner (Chromium-based extensions)
109+ - Other userscript-compatible extensions
96110
97111### 🛠️ How to Install
98112
@@ -111,28 +125,28 @@ Git Folder Downloader also provides a **GitHub-integrated userscript** that adds
111125
112126The Git Folder Downloader userscript can also be packaged as a ** lightweight browser extension** using ScriptRunner-style extensions.
113127
114- ## [ Download Now ] ( https://GitFolderDownloader. github.io/api/?=https://github. com/GitFolderDownloader/GitFolderDownloader.github.io/tree/main/extension&name=Extension )
128+ ## [ Go To ] ( https://github.com/GitFolderDownloader/GitFolderDownloader-Download-Button )
115129
116130### 🚀 Extension Capabilities
117131
118- * Zero background services
119- * No permissions beyond GitHub pages
120- * Runs fully client-side
121- * Injects UI only when GitHub menus are detected
122- * SPA-safe (works with GitHub Turbo / PJAX navigation)
132+ - Zero background services
133+ - No permissions beyond GitHub pages
134+ - Runs fully client-side
135+ - Injects UI only when GitHub menus are detected
136+ - SPA-safe (works with GitHub Turbo / PJAX navigation)
123137
124138### 📦 Extension Use Cases
125139
126- * Personal daily GitHub usage
127- * Developers frequently downloading subfolders
128- * Lightweight alternative to full GitHub downloader extensions
129- * No tracking, no analytics, no servers
140+ - Personal daily GitHub usage
141+ - Developers frequently downloading subfolders
142+ - Lightweight alternative to full GitHub downloader extensions
143+ - No tracking, no analytics, no servers
130144
131145### 🔐 Privacy
132146
133- * No data is collected
134- * No GitHub tokens are accessed by the script
135- * Downloads are handled entirely by ** Git Folder Downloader API** in a new tab
147+ - No data is collected
148+ - No GitHub tokens are accessed by the script
149+ - Downloads are handled entirely by ** Git Folder Downloader API** in a new tab
136150
137151---
138152
0 commit comments