Skip to content

Commit 6cb21b3

Browse files
committed
docs: minor updates [skip ci]
1 parent d078af4 commit 6cb21b3

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

.github/readme/partials/documentation/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 🧩 Plugins
22

3-
Plugins provide additional content and lets you customize your rendered metrics.
3+
Plugins provide additional content and lets you customize rendered metrics.
44

55
**📦 Maintained by core team**
66
<% { 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)) { %>

.github/readme/partials/documentation/setup.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ There are several ways to setup metrics, each having its advantages and disadvan
99
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)
1010
* ✔️ Easily configurable and previewable
1111
* ➖ Limited features *(compute-intensive features are disabled)*
12-
* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)*
12+
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
13+
* ✔️ Create another shared instance
14+
* ➖ Requires some sysadmin knowlegde
15+
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md)
1316
* ✔️ Suited for one-time rendering
14-
* [🏗️ Deploying your own web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
15-
* ➖ Mostly intended for development, or to create another shared instance
17+
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)
1618

1719
Additional resources for setup:
18-
* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md)
19-
* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)*
20+
* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md)
21+
* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md)

.github/readme/partials/documentation/setup/action.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ⚙️ Using GitHub Action on a profile repository (~10 min setup)
1+
# ⚙️ Using GitHub Action on a profile repository (~10 min)
22

33
Setup a GitHub Action which runs periodically and pushes generated images to a repository.
44

@@ -84,7 +84,7 @@ There are several *metrics* versions that can be used in workflows:
8484
- ✔️ Advised when using additional scopes in personal access token
8585
- ➖ Manual updates (watch new [releases](https://github.com/lowlighter/metrics/releases) for updates)
8686
- `@v{x}.{x}`
87-
-
87+
- Pinned versions have no real advantages
8888

8989
> 💡 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!
9090

@@ -112,11 +112,11 @@ Update profile `README.md` to include rendered image (filename may differ if `fi
112112
```
113113

114114
*Example: add rendered image with html for more customization*
115-
```markdown
116-
<img align="center" src="/github-metrics.svg" width="400">
115+
```html
116+
<img align="center" src="/github-metrics.svg" alt="Metrics" width="400">
117117
```
118118

119119
*Example: add rendered image when using `config_display: columns`*
120-
```markdown
121-
<img src="/github-metrics.svg" width="100%">
120+
```html
121+
<img src="/github-metrics.svg" alt="Metrics" width="100%">
122122
```

.github/readme/partials/introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
1414
-%>
1515
<tr>
1616
<th colspan="2" align="center">
17-
<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>
17+
<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>
1818
</th>
1919
</tr>
2020
<% if (elements.length%2)
@@ -39,7 +39,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
3939
<% }}} -%>
4040
<tr>
4141
<th colspan="2" align="center">
42-
<a href="/#-plugins">🎲 See also community plugins</a>
42+
<a href="/README.md#-pluginss">🎲 See also community plugins</a>
4343
</th>
4444
</tr>
4545
<% } %>
@@ -49,7 +49,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
4949
-%>
5050
<tr>
5151
<th colspan="2" align="center">
52-
<h3><a href="/source/templates/README.md">🖼️ And even more with <%= elements.length %>+ templates!</a></h3>
52+
<h3><a href="/README.md#%EF%B8%8F-templates">🖼️ And even more with <%= elements.length %>+ templates!</a></h3>
5353
</th>
5454
</tr>
5555
<% if (elements.length%2)
@@ -97,7 +97,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
9797
<tr>
9898
<td align="center" colspan="2">
9999
<b>Power user?</b><br>
100-
<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!
100+
<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!
101101
</td>
102102
</tr>
103103
</table>

0 commit comments

Comments
 (0)