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

docs: placeholder for missing docs

Browse Source
This commit is contained in:
lowlighter
2022-01-15 17:36:58 -05:00
parent 344c7a5927
commit 6109463ec6
3 changed files with 9 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,31 +1,3 @@
### 🧰 Plugin compatibility matrix
# 🧰 Template/Plugin compatibility matrix
<table>
<tr>
<th nowrap="nowrap">Template/Plugin</th><%# -%>
<% for (const [plugin, {name, icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key))&&(value.category !== "community"))) { %>
<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>
<td nowrap="nowrap"><%- name %></td><%# -%>
<% for (const [plugin] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key))&&(value.category !== "community"))) { %>
<td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= {true:"✔️", false:"❌", embed:"✓"}[readme.compatibility[plugin]] %></td><% } %>
</tr><% } %>
<tr>
<td colspan="<%= Object.keys(plugins).length %>"></td>
</tr>
<tr>
<th nowrap="nowrap">Mode/Plugin</th><%# -%>
<% for (const [plugin, {name, icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key))&&(value.category !== "community"))) { %>
<th nowrap="nowrap" align="center" title="<%= name %>"><%= icon %></th><% } %>
</tr><%# -%>
<% for (const {mode, icon} of [{mode:"user", icon:"👤"}, {mode:"organization", icon:"👥"}, {mode:"repository", icon:"📓"}]) { %>
<tr>
<td nowrap="nowrap"><%= icon %> <%- `${mode.charAt(0).toLocaleUpperCase()}${mode.substring(1)}` %></td><%# -%>
<% for (const [plugin, {supports}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key))&&(value.category !== "community"))) {%>
<td nowrap="nowrap" align="center" data-plugin="<%= plugin %>"><%= supports.includes(mode) ? "✔️" : "❌" %></td><% } %>
</tr><% } %>
</table>
*Note: **markdown template** can actually render any kind of SVG metrics using [`embed` function](https://github.com/lowlighter/metrics/blob/master/source/templates/markdown/example.md#embedding-svg-metrics)*
*Documentation not available yet*

3
.github/readme/partials/documentation/setup/docker.md vendored Normal file
View File

@@ -0,0 +1,3 @@
# 🐳 Using command line with docker (~5 min)
*Documentation not available yet*

4
.github/readme/partials/documentation/setup/local.md vendored Normal file
View File

@@ -0,0 +1,4 @@
# 🔧 Local setup for development (~20 min)
*Documentation not available yet*