docs: update quickstart utilities [skip ci]

This commit is contained in:
lowlighter
2022-01-15 14:51:19 -05:00
parent 54590f152d
commit ea8723c7dd
5 changed files with 35 additions and 35 deletions

View File

@@ -1,19 +1,12 @@
### 🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> <!--header-->
<!--/header-->
<table> ## ➡️ Available options
<td align="center">
<img src="">
<img width="900" height="1" alt="">
</td>
</table>
#### Examples workflows <!--options-->
<!--/options-->
[➡️ Available options for this plugin](metadata.yml) ## Examples workflows
```yaml <!--examples-->
- uses: lowlighter/metrics@latest <!--/examples-->
with:
# ... other options
plugin_<%= name %>: yes
```

View File

@@ -1,7 +1,9 @@
- name: <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> plugin (default) - name: Example
uses: lowlighter/metrics@latest uses: lowlighter/metrics@latest
with: with:
filename: metrics.plugin.<%= name %>.svg filename: metrics.plugin.<%= name %>.svg
token: ${{ secrets.METRICS_TOKEN }} token: ${{ secrets.METRICS_TOKEN }}
base: "" base: ""
plugin_<%= name %>: yes plugin_<%= name %>: yes
prod:
skip: true

View File

@@ -1,14 +1,16 @@
name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>" name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
category: community # Leave as it category: community
description: Short description
examples:
default: https://via.placeholder.com/468x60?text=No%20preview%20available
supports: supports:
- user # Support users account - user
- organization # Support organizations account - organization
- repository # Support repositories metrics - repository
scopes: [] # Required scopes for personal access token scopes: []
inputs: inputs:
# Enable or disable plugin
plugin_<%= name %>: plugin_<%= name %>:
description: description description: Enable <%= name %> plugin
type: boolean type: boolean
default: no default: no

View File

@@ -2,6 +2,7 @@
<defs><style><%%= fonts %></style></defs> <defs><style><%%= fonts %></style></defs>
<style data-optimizable="true"><%%= style %></style> <style data-optimizable="true"><%%= style %></style>
<style><%= extras.css %></style>
<foreignObject x="0" y="0" width="100%" height="100%"> <foreignObject x="0" y="0" width="100%" height="100%">
<div xmlns="http://www.w3.org/1999/xhtml" xmlns:xlink="http://www.w3.org/1999/xlink"> <div xmlns="http://www.w3.org/1999/xhtml" xmlns:xlink="http://www.w3.org/1999/xlink">

Before

Width:  |  Height:  |  Size: 562 B

After

Width:  |  Height:  |  Size: 597 B

View File

@@ -1,14 +1,16 @@
name: "🖼️ Template name" name: "🖼️ Template name"
extends: classic # Fallback to "classic" template "template.mjs" if not trusted extends: classic
index: ~ # Leave as it (this is used to order plugins on metrics README.md) description: Short description
examples:
default: https://via.placeholder.com/468x60?text=No%20preview%20available
supports: supports:
- user # Support users account - user
- organization # Support organizations account - organization
- repository # Support repositories metrics - repository
formats: formats:
- svg # Support SVG output - svg
- png # Support PNG output - png
- jpeg # Support JPEG output - jpeg
- json # Support JSON output - json
- markdown # Support markdown output - markdown
- markdown-pdf # Support PDF output - markdown-pdf