sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: improve community plugin docs [skip ci]

Browse Source
This commit is contained in:
lowlighter
2021-11-26 17:52:29 -05:00
parent 65145b9bc7
commit e4ff40453a
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.github/readme/partials/documentation/plugins.md vendored
View File

@@ -1,11 +1,19 @@
## 🧩 Plugins
Plugins are features which provide additional content and lets you customize your rendered metrics.
See their respective documentation for more informations about how to setup them.
See their respective documentation for more informations about how to setup them:
<% { let previous = null; for (const [plugin, {name, category, authors = []}] of Object.entries(plugins).filter(([key, value]) => value).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %>
The following plugins are maintained by Metric's 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)) { %>
<% if (previous !== category) { previous = category -%>
* **<%= `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)}` %>**<% if (category === "community") { %> *(provided and maintained by contributors)*<% } %>
* **<%= `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)}` %>**
<% } -%>
* [<%- name %>](/source/plugins/<%= plugin %>/README.md)<% if (category === "community") { %> <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %><% } %><%# -%>
* [<%- name %>](/source/plugins/<%= plugin %>/README.md)<%# -%>
<% }} %>
### 🎲 Community plugins
The following plugins are provided and maintained by Metrics's user community:
<% { 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 %>](/source/plugins/<%= plugin %>/README.md) <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %><%# -%>
<% }} %>

4
.github/readme/partials/introduction.md vendored
View File

@@ -15,7 +15,7 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
</table>
<% {
let cell = 0
const elements = Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key)&&(!value.community)))
const elements = Object.entries(plugins).filter(([key, value]) => (value)&&(!["base", "core"].includes(key)&&(value.category !== "community")))
%>
And you can customize these heavily with plugins, templates and hundreds of options!
@@ -23,7 +23,7 @@ And you can customize these heavily with plugins, templates and hundreds of opti
<table>
<tr>
<th colspan="2" align="center">
<a href="source/plugins/README.md">🧩 <%= elements.length %> plugins</a>
<a href="source/plugins/README.md">🧩 <%= elements.length %>+ plugins</a>
</th>
</tr>
<% if (elements.length%2)