Skip to content

Commit 12db875

Browse files
committed
docs(templates): minor changes [skip ci]
1 parent 9c4315e commit 12db875

File tree

4 files changed

+17
-4
lines changed

4 files changed

+17
-4
lines changed

source/app/metrics/metadata.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ metadata.template = async function({__templates, name, plugins, logger}) {
389389
` <tr><td colspan="2" align="center">${(meta.description ?? "").replaceAll("\n", "<br>")}</td></tr>`,
390390
` <tr>`,
391391
` <th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>`,
392-
` <td>${Object.entries(compatibility).filter(([_, value]) => value).map(([id]) => `<a href="/source/plugins/${id}" title="${plugins[id].name}">${plugins[id].icon}</a>`).join(" ")}</td>`,
392+
` <td>${Object.entries(compatibility).filter(([_, value]) => value).map(([id]) => `<a href="/source/plugins/${id}" title="${plugins[id].name}">${plugins[id].icon}</a>`).join(" ")}${meta.formats?.includes("markdown") ? "<code>✓ embed()</code>" : ""}</td>`,
393393
` </tr>`,
394394
` <tr>`,
395395
` <td>${[

source/templates/community/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
</tr>
1010
</table>
1111

12-
___
13-
1412
Community templates are a way to use official releases of [lowlighter/metrics](https://github.com/lowlighter/metrics) while using templates from external repositories (owned or not).
1513

1614
## 📮 Using community templates

source/templates/markdown/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<tr><td colspan="2" align="center">A template capable of rendering markdown from a given template file.</td></tr>
55
<tr>
66
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
7-
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a></td>
7+
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a><code>✓ embed()</code></td>
88
</tr>
99
<tr>
1010
<td>👤 Users, 👥 Organizations</td>

source/templates/repository/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@
2121
</table>
2222
<!--/header-->
2323

24+
## 🎎 Using a repository template
25+
26+
To use a repository template, a `repo` handle must be provided.
27+
28+
If the token owner is not the repository owner, then the `user` option must be set to the repository owner (whether it is an user or organization account).
29+
30+
*Example: render `lowlighter/metrics` repository*
31+
```yml
32+
- uses: lowlighter/metrics@latest
33+
with:
34+
template: repository
35+
user: lowlighter
36+
repo: metrics
37+
```
38+
2439
## ℹ️ Examples workflows
2540
2641
<!--examples-->

0 commit comments

Comments
 (0)