docs: add navigation links

This commit is contained in:
lowlighter
2022-04-24 11:45:02 -04:00
parent 518cd31cc3
commit 4a3be3bdab
3 changed files with 7 additions and 4 deletions

View File

@@ -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 %> <sub>`<%= plugin %>`</sub>](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
<% }} %>

View File

@@ -335,6 +335,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
//Header table
const header = [
"<table>",
` <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr>`,
` <tr><th colspan="2"><h3>${meta.name}</h3></th></tr>`,
` <tr><td colspan="2" align="center">${marked.parse(meta.description ?? "", {silent: true})}</td></tr>`,
meta.authors?.length ? `<tr><th>Authors</th><td>${[meta.authors].flat().map(author => `<a href="https://github.com/${author}">@${author}</a>`)}</td></tr>` : "",
@@ -370,7 +371,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
const table = [
"<table>",
" <tr>",
' <td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>',
' <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td>',
" </tr>",
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 = [
"<table>",
` <tr><td colspan="2"><a href="/README.md#%EF%B8%8F-templates">← Back to templates index</a></td></tr>`,
` <tr><th colspan="2"><h3>${meta.name ?? "(unnamed template)"}</h3></th></tr>`,
` <tr><td colspan="2" align="center">${marked.parse(meta.description ?? "", {silent: true})}</td></tr>`,
" <tr>",

View File

@@ -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