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

feat(plugins/topics): add labels alias (#776) [skip ci]

Browse Source
This commit is contained in:
Simon Lecoq
2022-01-16 00:32:51 +01:00
committed by GitHub
parent db2be65db1
commit 29b445d5b5
4 changed files with 89 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
source/plugins/topics/README.md
View File

@@ -1,21 +1,28 @@
### 📌 Starred topics
The *topics* plugin displays your [starred topics](https://github.com/stars?filter=topics).
Check out [GitHub topics](https://github.com/topics) to search interesting topics.
<!--header-->
<table>
<td align="center">
<details open><summary>With icons</summary>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.icons.svg">
</details>
<details open><summary>With labels</summary>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.svg">
</details>
<img width="900" height="1" alt="">
</td>
<tr><th colspan="2"><h3>📌 Starred topics</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin displays <a href="https://github.com/stars?filter=topics">starred topics</a>.
Check out <a href="https://github.com/topics">GitHub topics</a> to search interesting topics.</p>
</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/markdown"><code>📒 Markdown template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code></td>
</tr>
<tr>
<td><i>No tokens are required for this plugin</i></td>
</tr>
<tr>
<td colspan="2" align="center">
<details open><summary>With icons</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.icons.svg" alt=""></img></details>
<details open><summary>With labels</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
This uses puppeteer to navigate through your starred topics page.
<!--/header-->
#### ➡️ Available options
@@ -26,7 +33,8 @@ This uses puppeteer to navigate through your starred topics page.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics</code></td>
<td rowspan="2">Display starred topics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Enable topics plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -35,17 +43,31 @@ This uses puppeteer to navigate through your starred topics page.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_mode</code></td>
<td rowspan="2">Plugin mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display mode:</p>
<ul>
<li><code>labels</code>: display labels</li>
<li><code>icons</code>: display icons <em>(topics without icons will be ignored)</em></li>
<li><code>starred</code>: alias for <code>labels</code></li>
<li><code>mastered</code>: alias for <code>icons</code></li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
<br>
<b>default:</b> starred<br>
<b>allowed values:</b><ul><li>starred</li><li>icons</li><li>mastered</li></ul></td>
<b>allowed values:</b><ul><li>labels</li><li>icons</li><li>starred</li><li>mastered</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_sort</code></td>
<td rowspan="2">Sorting method of starred topics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sorting method:</p>
<ul>
<li><code>stars</code>: sort by most stars</li>
<li><code>activity</code>: sort by recent activity</li>
<li><code>starred</code>: sort by the date you starred them</li>
<li><code>random</code>: sort topics randomly</li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -55,7 +77,9 @@ This uses puppeteer to navigate through your starred topics page.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_limit</code></td>
<td rowspan="2">Maximum number of topics to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display limit</p>
<p>When using <code>plugin_topics_mode: labels</code>, an ellipsis will be displayed</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -63,6 +87,7 @@ This uses puppeteer to navigate through your starred topics page.
𝑥
≤ 20)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 15<br></td>
</tr>
</table>