Update documentation and reorder plugins by categorie
This commit is contained in:
15
.github/quickstart/plugin/metadata.yml
vendored
15
.github/quickstart/plugin/metadata.yml
vendored
@@ -1,15 +1,10 @@
|
||||
name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
|
||||
|
||||
# Estimate of how many GitHub requests will be used
|
||||
cost: N/A
|
||||
|
||||
# Supported modes
|
||||
cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
|
||||
categorie: other # Set plugin categorie ("github", "social", "health" or "other")
|
||||
supports:
|
||||
- user
|
||||
- organization
|
||||
- repository
|
||||
|
||||
# Inputs list
|
||||
- user # Support users account
|
||||
- organization # Support organizations account
|
||||
- repository # Support repositories metrics
|
||||
inputs:
|
||||
|
||||
# Enable or disable plugin
|
||||
|
||||
2
.github/readme/README.md
vendored
2
.github/readme/README.md
vendored
@@ -2,6 +2,6 @@
|
||||
|
||||

|
||||
|
||||
<% 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`) %>
|
||||
<% } %>
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -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
2
.github/readme/partials/license.md
vendored
@@ -5,4 +5,4 @@ MIT License
|
||||
Copyright (c) 2020 lowlighter
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
Reference in New Issue
Block a user