From 4a3be3bdab58efac01b42af60847b0e940fc1df3 Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Sun, 24 Apr 2022 11:45:02 -0400
Subject: [PATCH] docs: add navigation links
---
.github/readme/partials/templated/plugins.md | 3 ++-
source/app/metrics/metadata.mjs | 4 +++-
source/plugins/calendar/metadata.yml | 4 ++--
3 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/.github/readme/partials/templated/plugins.md b/.github/readme/partials/templated/plugins.md
index 0f8bb0f2..9190f2a7 100644
--- a/.github/readme/partials/templated/plugins.md
+++ b/.github/readme/partials/templated/plugins.md
@@ -11,6 +11,7 @@ Plugins provide additional content and lets you customize rendered metrics.
<% }} %>
**🎲 Maintained by community**
+* [Community plugins](/source/plugins/community/README.md)
<% { 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)) { %><%# -%>
-* [<%- name %> `<%= plugin %>`](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
+ * [<%- name %> `<%= plugin %>`](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
<% }} %>
\ No newline at end of file
diff --git a/source/app/metrics/metadata.mjs b/source/app/metrics/metadata.mjs
index 0e612f16..54ca9756 100644
--- a/source/app/metrics/metadata.mjs
+++ b/source/app/metrics/metadata.mjs
@@ -335,6 +335,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
//Header table
const header = [
"
",
+ ` | ← Back to plugins index |
`,
` ${meta.name} |
`,
` | ${marked.parse(meta.description ?? "", {silent: true})} |
`,
meta.authors?.length ? `| Authors | ${[meta.authors].flat().map(author => `@${author}`)} |
` : "",
@@ -370,7 +371,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
const table = [
"",
" ",
- ' | Type | Description | ',
+ ' Option | Description | ',
"
",
Object.entries(inputs).map(([option, {description, type, ...o}]) => {
const cell = []
@@ -462,6 +463,7 @@ metadata.template = async function({__templates, name, plugins}) {
//Header table
const header = [
"",
+ ` | ← Back to templates index |
`,
` ${meta.name ?? "(unnamed template)"} |
`,
` | ${marked.parse(meta.description ?? "", {silent: true})} |
`,
" ",
diff --git a/source/plugins/calendar/metadata.yml b/source/plugins/calendar/metadata.yml
index 2be1ec29..87c8d267 100644
--- a/source/plugins/calendar/metadata.yml
+++ b/source/plugins/calendar/metadata.yml
@@ -2,8 +2,8 @@ name: "📆 Calendar"
category: github
description: This plugin displays your commit calendar across several years
examples:
- +current year: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.svg
- full history: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.full.svg
+ current year: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.svg
+ +full history: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.full.svg
index: 25
supports:
- user