docs(plugins/isocalendar): full rewrite
This commit is contained in:
@@ -1,54 +1,12 @@
|
||||
### 📅 Isometric commit calendar
|
||||
<!--header-->
|
||||
<!--/header-->
|
||||
|
||||
The *isocalendar* plugin displays an isometric view of your commits calendar, along with a few additional stats like current streak and commit average per day.
|
||||
|
||||
<table>
|
||||
<td align="center">
|
||||
<details open><summary>Full year isometric calendar</summary>
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg">
|
||||
</details>
|
||||
<details><summary>Half year isometric calendar</summary>
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg">
|
||||
</details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</table>
|
||||
|
||||
#### ➡️ Available options
|
||||
## ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_isocalendar` | `boolean` **[no]** | Display an isometric view of your commits calendar |
|
||||
| `plugin_isocalendar_duration` | `string` **[half-year]** *{"half-year", "full-year"}* | Set time window shown by isometric calendar |
|
||||
|
||||
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
## ℹ️ Examples workflows
|
||||
|
||||
<!--examples-->
|
||||
```yaml
|
||||
name: Half-year calendar
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.isocalendar.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_isocalendar: 'yes'
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: Full-year calendar
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.isocalendar.fullyear.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_isocalendar: 'yes'
|
||||
plugin_isocalendar_duration: full-year
|
||||
|
||||
```
|
||||
<!--/examples-->
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
name: "📅 Isometric commit calendar"
|
||||
category: github
|
||||
description: This plugin displays an isometric view of your commit calendar along with a few additional statistics like current streak and average number of commit per day.
|
||||
examples:
|
||||
full year calendar: https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg
|
||||
half year calendar: https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg
|
||||
index: 0
|
||||
supports:
|
||||
- user
|
||||
@@ -7,15 +11,13 @@ scopes:
|
||||
- public_access
|
||||
inputs:
|
||||
|
||||
# Enable or disable plugin
|
||||
plugin_isocalendar:
|
||||
description: Display an isometric view of your commits calendar
|
||||
description: Enable isocalendar plugin
|
||||
type: boolean
|
||||
default: no
|
||||
|
||||
# Set time window shown by isometric calendar
|
||||
plugin_isocalendar_duration:
|
||||
description: Set time window shown by isometric calendar
|
||||
description: Time window
|
||||
type: string
|
||||
default: half-year
|
||||
values:
|
||||
|
||||
Reference in New Issue
Block a user