docs: minor updates [skip ci]
This commit is contained in:
@@ -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)) { %>
|
||||
|
||||
12
.github/readme/partials/documentation/setup.md
vendored
12
.github/readme/partials/documentation/setup.md
vendored
@@ -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)
|
||||
@@ -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%">
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user