docs: minor updates [skip ci]

This commit is contained in:
lowlighter
2022-01-15 17:37:27 -05:00
parent d078af4180
commit 6cb21b31ca
4 changed files with 18 additions and 16 deletions

View File

@@ -1,6 +1,6 @@
## 🧩 Plugins
Plugins provide additional content and lets you customize your rendered metrics.
Plugins provide additional content and lets you customize rendered metrics.
**📦 Maintained by core team**
<% { let previous = null; for (const [plugin, {name, category, authors = []}] of Object.entries(plugins).filter(([key, value]) => (value)&&(value.category !== "community")).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %>

View File

@@ -9,11 +9,13 @@ There are several ways to setup metrics, each having its advantages and disadvan
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)
* ✔️ Easily configurable and previewable
* Limited features *(compute-intensive features are disabled)*
* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)*
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* ✔️ Create another shared instance
* Requires some sysadmin knowlegde
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md)
* ✔️ Suited for one-time rendering
* [🏗️ Deploying your own web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* Mostly intended for development, or to create another shared instance
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)
Additional resources for setup:
* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md)
* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)*
* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md)
* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md)

View File

@@ -1,4 +1,4 @@
# ⚙️ Using GitHub Action on a profile repository (~10 min setup)
# ⚙️ Using GitHub Action on a profile repository (~10 min)
Setup a GitHub Action which runs periodically and pushes generated images to a repository.
@@ -84,7 +84,7 @@ There are several *metrics* versions that can be used in workflows:
- ✔️ Advised when using additional scopes in personal access token
- Manual updates (watch new [releases](https://github.com/lowlighter/metrics/releases) for updates)
- `@v{x}.{x}`
-
- Pinned versions have no real advantages
> 💡 Workflows are always compatible with previous version as *metrics* workflow-breaking changes are never introduced. In fact, even workflows from v1.0 are still compatible!
@@ -112,11 +112,11 @@ Update profile `README.md` to include rendered image (filename may differ if `fi
```
*Example: add rendered image with html for more customization*
```markdown
<img align="center" src="/github-metrics.svg" width="400">
```html
<img align="center" src="/github-metrics.svg" alt="Metrics" width="400">
```
*Example: add rendered image when using `config_display: columns`*
```markdown
<img src="/github-metrics.svg" width="100%">
```html
<img src="/github-metrics.svg" alt="Metrics" width="100%">
```

View File

@@ -14,7 +14,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
-%>
<tr>
<th colspan="2" align="center">
<h3><a href="/source/plugins/README.md">🧩 Customizable with <%= Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key))).length %> plugins and <%= Object.entries(descriptor.inputs).length %> options!</a></h3>
<h3><a href="/README.md#-plugins">🧩 Customizable with <%= Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key))).length %> plugins and <%= Object.entries(descriptor.inputs).length %> options!</a></h3>
</th>
</tr>
<% if (elements.length%2)
@@ -39,7 +39,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<% }}} -%>
<tr>
<th colspan="2" align="center">
<a href="/#-plugins">🎲 See also community plugins</a>
<a href="/README.md#-pluginss">🎲 See also community plugins</a>
</th>
</tr>
<% } %>
@@ -49,7 +49,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
-%>
<tr>
<th colspan="2" align="center">
<h3><a href="/source/templates/README.md">🖼️ And even more with <%= elements.length %>+ templates!</a></h3>
<h3><a href="/README.md#%EF%B8%8F-templates">🖼️ And even more with <%= elements.length %>+ templates!</a></h3>
</th>
</tr>
<% if (elements.length%2)
@@ -97,7 +97,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<tr>
<td align="center" colspan="2">
<b>Power user?</b><br>
<a href="https://github.com/lowlighter/metrics/fork">Fork this repository</a> and edit HTML, CSS, JS and <a href="https://github.com/mde/ejs"> for even more customization!
<a href="https://github.com/lowlighter/metrics/fork">Fork this repository</a> and edit HTML, CSS, JS and <a href="https://github.com/mde/ejs">EJS</a> for even more customization!
</td>
</tr>
</table>