Skip to content

Commit 7a5ac44

Browse files
alexandr-garbuzovqwerty541Copilot
authored
docs(readme): change available envs formatting to the table instead of list (#4602)
* docs(readme): change available envs formatting to the table instead of list * dev * dev * dev * dev * dev * dev * dev * dev * dev * dev * Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]> * Apply suggestion from @Copilot Co-authored-by: Copilot <[email protected]> * dev --------- Co-authored-by: Alexandr <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent 5706197 commit 7a5ac44

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

readme.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -890,11 +890,42 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
890890

891891
GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include:
892892

893-
* `CACHE_SECONDS`: Sets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. You can also set it to `0` to disable caching completely. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).
894-
* `WHITELIST`: A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.
895-
* `GIST_WHITELIST`: A comma-separated list of GitHub gist IDs that are allowed to be accessed on your instance. If this variable is not set, all gist IDs are allowed.
896-
* `EXCLUDE_REPO`: A comma-separated list of repositories that will be excluded from stats and top languages cards on your instance. This allows repository exclusion without exposing repository names in public URLs. This enhances privacy for self-hosted instances that include private repositories in stats cards.
897-
* `FETCH_MULTI_PAGE_STARS`: When set to `true`, this enables fetching all starred repositories for accurate star counts, especially for users with more than 100 repositories. This may increase response times and API points usage, so it is disabled on the public instance.
893+
<table>
894+
<thead>
895+
<tr>
896+
<th>Name</th>
897+
<th>Description</th>
898+
<th>Supported values</th>
899+
</tr>
900+
</thead>
901+
<tbody>
902+
<tr>
903+
<td><code>CACHE_SECONDS</code></td>
904+
<td>Sets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).</td>
905+
<td>Any positive integer or <code>0</code> to disable caching</td>
906+
</tr>
907+
<tr>
908+
<td><code>WHITELIST</code></td>
909+
<td>A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.</td>
910+
<td>Comma-separated GitHub usernames</td>
911+
</tr>
912+
<tr>
913+
<td><code>GIST_WHITELIST</code></td>
914+
<td>A comma-separated list of GitHub Gist IDs that are allowed to be accessed on your instance. If this variable is not set, all Gist IDs are allowed.</td>
915+
<td>Comma-separated GitHub Gist IDs</td>
916+
</tr>
917+
<tr>
918+
<td><code>EXCLUDE_REPO</code></td>
919+
<td>A comma-separated list of repositories that will be excluded from stats and top languages cards on your instance. This allows repository exclusion without exposing repository names in public URLs. This enhances privacy for self-hosted instances that include private repositories in stats cards.</td>
920+
<td>Comma-separated repository names</td>
921+
</tr>
922+
<tr>
923+
<td><code>FETCH_MULTI_PAGE_STARS</code></td>
924+
<td>Enables fetching all starred repositories for accurate star counts, especially for users with more than 100 repositories. This may increase response times and API points usage, so it is disabled on the public instance.</td>
925+
<td><code>true</code> or <code>false</code></td>
926+
</tr>
927+
</tbody>
928+
</table>
898929

899930
See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance.
900931

0 commit comments

Comments
 (0)