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

Update documentation and reorder plugins by categorie

Browse Source
This commit is contained in:
lowlighter
2021-02-17 14:09:20 +01:00
parent 27ff6585ff
commit 404c643bcf
9 changed files with 27 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/readme/README.md vendored
View File

@@ -2,6 +2,6 @@
![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg)
<% for (const partial of ["introduction", "shared", "setup", "documentation", "references", "license"]) { -%>
<% for (const partial of ["introduction", "shared", "setup", "documentation", "license", "references"]) { -%>
<%- await include(`/partials/${partial}.md`) %>
<% } %>

4
.github/readme/partials/documentation/compatibility.md vendored
View File

@@ -3,8 +3,8 @@
<table>
<tr>
<th nowrap="nowrap">Template\Plugin</th><%# -%>
<% for (const [plugin, {icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
<th nowrap="nowrap" align="center"><%= icon %></th><% } %>
<% for (const [plugin, {name, icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
<th nowrap="nowrap" align="center" title="<%= name %>"><%= icon %></th><% } %>
</tr><%# -%>
<% for (const [template, {name, readme}] of Object.entries(templates).filter(([key, value]) => (value)&&(!["community"].includes(key)))) { %>
<tr>

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

@@ -2,6 +2,9 @@
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:
<% for (const [plugin, {name}] of Object.entries(plugins).filter(([key, value]) => value)) { %>
* [<%= name %>](/source/plugins/<%= plugin %>/README.md)<%# -%>
<% } %>
<% { let previous = null; for (const [plugin, {name, categorie}] of Object.entries(plugins).filter(([key, value]) => value)) { %>
<% if (previous !== categorie) { previous = categorie -%>
* **<%= `${categorie.charAt(0).toLocaleUpperCase()}${categorie.substring(1)}` %>**
<% } -%>
* [<%= name %>](/source/plugins/<%= plugin %>/README.md)<%# -%>
<% }} %>

2
.github/readme/partials/license.md vendored
View File

@@ -5,4 +5,4 @@ MIT License
Copyright (c) 2020 lowlighter
```
![License details](https://github.com/lowlighter/lowlighter/blob/master/metrics.licenses.svg)
![License details](https://github.com/lowlighter/lowlighter/blob/master/metrics.licenses.svg)