diff --git a/.github/readme/partials/documentation/plugins.md b/.github/readme/partials/documentation/plugins.md index b18a5422..5d2d932a 100644 --- a/.github/readme/partials/documentation/plugins.md +++ b/.github/readme/partials/documentation/plugins.md @@ -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)) { %> diff --git a/.github/readme/partials/documentation/setup.md b/.github/readme/partials/documentation/setup.md index 4f00b9d7..ded3254e 100644 --- a/.github/readme/partials/documentation/setup.md +++ b/.github/readme/partials/documentation/setup.md @@ -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)* \ No newline at end of file +* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md) +* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md) \ No newline at end of file diff --git a/.github/readme/partials/documentation/setup/action.md b/.github/readme/partials/documentation/setup/action.md index 490aa696..9f542515 100644 --- a/.github/readme/partials/documentation/setup/action.md +++ b/.github/readme/partials/documentation/setup/action.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 - +```html +Metrics ``` *Example: add rendered image when using `config_display: columns`* -```markdown - +```html +Metrics ``` diff --git a/.github/readme/partials/introduction.md b/.github/readme/partials/introduction.md index 404d14fd..e09adf7c 100644 --- a/.github/readme/partials/introduction.md +++ b/.github/readme/partials/introduction.md @@ -14,7 +14,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -%> -

🧩 Customizable with <%= Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key))).length %> plugins and <%= Object.entries(descriptor.inputs).length %> options!

+

🧩 Customizable with <%= Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key))).length %> plugins and <%= Object.entries(descriptor.inputs).length %> options!

<% if (elements.length%2) @@ -39,7 +39,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile <% }}} -%> - 🎲 See also community plugins + 🎲 See also community plugins <% } %> @@ -49,7 +49,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -%> -

🖼️ And even more with <%= elements.length %>+ templates!

+

🖼️ And even more with <%= elements.length %>+ templates!

<% if (elements.length%2) @@ -97,7 +97,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile Power user?
- Fork this repository and edit HTML, CSS, JS and for even more customization! + Fork this repository and edit HTML, CSS, JS and EJS for even more customization!