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 <175728472+Copilot@users.noreply.github.com> * Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * dev --------- Co-authored-by: Alexandr <qwerty541zxc@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-19 21:47:24 +03:00
parent 570619752f
commit 7a5ac44604
1 changed files with 36 additions and 5 deletions
@@ -890,11 +890,42 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme

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

-*   `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).
-*   `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.
-*   `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.
-*   `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.
-*   `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.
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Description</th>
+      <th>Supported values</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>CACHE_SECONDS</code></td>
+      <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>
+      <td>Any positive integer or <code>0</code> to disable caching</td>
+    </tr>
+    <tr>
+      <td><code>WHITELIST</code></td>
+      <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>
+      <td>Comma-separated GitHub usernames</td>
+    </tr>
+    <tr>
+      <td><code>GIST_WHITELIST</code></td>
+      <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>
+      <td>Comma-separated GitHub Gist IDs</td>
+    </tr>
+    <tr>
+      <td><code>EXCLUDE_REPO</code></td>
+      <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>
+      <td>Comma-separated repository names</td>
+    </tr>
+    <tr>
+      <td><code>FETCH_MULTI_PAGE_STARS</code></td>
+      <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>
+      <td><code>true</code> or <code>false</code></td>
+    </tr>
+  </tbody>
+</table>

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