From 12db875ad6aead1dc56a8ef1905c5a19614deebd Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Fri, 14 Jan 2022 22:21:03 -0500 Subject: [PATCH] docs(templates): minor changes [skip ci] --- source/app/metrics/metadata.mjs | 2 +- source/templates/community/README.md | 2 -- source/templates/markdown/README.md | 2 +- source/templates/repository/README.md | 15 +++++++++++++++ 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/source/app/metrics/metadata.mjs b/source/app/metrics/metadata.mjs index 9a937f0a..1751cfbf 100644 --- a/source/app/metrics/metadata.mjs +++ b/source/app/metrics/metadata.mjs @@ -389,7 +389,7 @@ metadata.template = async function({__templates, name, plugins, logger}) { ` ${(meta.description ?? "").replaceAll("\n", "
")}`, ` `, ` Supported features
→ Full specification`, - ` ${Object.entries(compatibility).filter(([_, value]) => value).map(([id]) => `${plugins[id].icon}`).join(" ")}`, + ` ${Object.entries(compatibility).filter(([_, value]) => value).map(([id]) => `${plugins[id].icon}`).join(" ")}${meta.formats?.includes("markdown") ? "✓ embed()" : ""}`, ` `, ` `, ` ${[ diff --git a/source/templates/community/README.md b/source/templates/community/README.md index 422b8347..5918ea5d 100644 --- a/source/templates/community/README.md +++ b/source/templates/community/README.md @@ -9,8 +9,6 @@ -___ - 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). ## 📮 Using community templates diff --git a/source/templates/markdown/README.md b/source/templates/markdown/README.md index b1e9d004..1f9ad298 100644 --- a/source/templates/markdown/README.md +++ b/source/templates/markdown/README.md @@ -4,7 +4,7 @@ A template capable of rendering markdown from a given template file. Supported features
→ Full specification - 📰 âœ’ī¸ đŸ—ŧ 📌 🐤 + 📰 âœ’ī¸ đŸ—ŧ 📌 🐤✓ embed() 👤 Users, đŸ‘Ĩ Organizations diff --git a/source/templates/repository/README.md b/source/templates/repository/README.md index 75643dc9..2c17cc01 100644 --- a/source/templates/repository/README.md +++ b/source/templates/repository/README.md @@ -21,6 +21,21 @@ +## 🎎 Using a repository template + +To use a repository template, a `repo` handle must be provided. + +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). + +*Example: render `lowlighter/metrics` repository* +```yml +- uses: lowlighter/metrics@latest + with: + template: repository + user: lowlighter + repo: metrics +``` + ## â„šī¸ Examples workflows