docs: move templated files to a dedicated folder
This commit is contained in:
7
.github/readme/partials/templated/README.md
vendored
Normal file
7
.github/readme/partials/templated/README.md
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
|
||||
|
||||
[](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
|
||||
|
||||
<% for (const partial of ["templated/introduction", "templated/documentation", "license"]) { -%>
|
||||
<%- await include(`/partials/${partial}.md`) %>
|
||||
<% } %>
|
||||
31
.github/readme/partials/templated/compatibility.md
vendored
Normal file
31
.github/readme/partials/templated/compatibility.md
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
# 🧰 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)*
|
||||
@@ -4,6 +4,6 @@
|
||||
> <sup>*⚠️ This is the documentation of **v<%= packaged.version.replace(/[.]0-beta$/, "") %>-beta** (`@master`/`@main` branches) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master). See documentation for [**v<%= (Number(packaged.version.replace(/[.]0-beta$/, ""))-0.01).toFixed(2).replace(/[.]0/, ".") %>** (`@latest` branch) here](https://github.com/lowlighter/metrics/blob/latest/README.md).*</sup>
|
||||
<% } %>
|
||||
|
||||
<% for (const partial of ["setup", "templates", "plugins", "contributing"]) { %>
|
||||
<%- await include(`/partials/documentation/${partial}.md`) -%>
|
||||
<% for (const partial of ["documentation/setup", "templated/templates", "templated/plugins", "documentation/contributing"]) { %>
|
||||
<%- await include(`/partials/${partial}.md`) -%>
|
||||
<% } %>
|
||||
Reference in New Issue
Block a user