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

docs(templates): regenerate documentation

Browse Source
This commit is contained in:
lowlighter
2022-01-14 22:11:17 -05:00
parent 7228fc3b6d
commit 611347212c
6 changed files with 212 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
.github/scripts/quickstart/template/README.md vendored
View File

@@ -1,18 +1,7 @@
### 📕 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %> template
<table>
<td align="center">
<img src="">
<img width="900" height="1" alt="">
</td>
</table>
<!--header-->
<!--/header-->
#### ℹ️ Examples workflows
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
setup_community_templates: user/metrics@master:<%= name %>
template: "@<%= name %>"
```
<!--examples-->
<!--/examples-->

46
source/templates/classic/README.md
View File

@@ -1,21 +1,37 @@
### 📗 Classic template
Default template, mimicking GitHub visual identity.
<!--header-->
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg">
<img width="900" height="1" alt="">
</td>
<tr><th colspan="2"><h3>📗 Classic template</h3></th></tr>
<tr><td colspan="2" align="center">A template mimicking GitHub visual identity.<br>This is also the default template.<br></td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/plugins/achievements" title="🏆 Achievements">🏆</a> <a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/anilist" title="🌸 Anilist watch list and reading list">🌸</a> <a href="/source/plugins/code" title="♐ Code snippet of the day">♐</a> <a href="/source/plugins/discussions" title="💬 Discussions">💬</a> <a href="/source/plugins/followup" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/gists" title="🎫 Gists">🎫</a> <a href="/source/plugins/habits" title="💡 Coding habits">💡</a> <a href="/source/plugins/introduction" title="🙋 Introduction">🙋</a> <a href="/source/plugins/isocalendar" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/lines" title="👨‍💻 Lines of code changed">👨‍💻</a> <a href="/source/plugins/music" title="🎼 Music plugin">🎼</a> <a href="/source/plugins/nightscout" title="💉 Nightscout">💉</a> <a href="/source/plugins/notable" title="🎩 Notable contributions">🎩</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/people" title="🧑‍🤝‍🧑 People plugin">🧑‍🤝‍🧑</a> <a href="/source/plugins/poopmap" title="💩 PoopMap plugin">💩</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects" title="🗂️ Active projects">🗂️</a> <a href="/source/plugins/reactions" title="🎭 Comment reactions">🎭</a> <a href="/source/plugins/repositories" title="📓 Repositories">📓</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/skyline" title="🌇 GitHub Skyline 3D calendar">🌇</a> <a href="/source/plugins/sponsors" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/stackoverflow" title="🗨️ Stackoverflow plugin">🗨️</a> <a href="/source/plugins/stargazers" title="✨ Stargazers over last weeks">✨</a> <a href="/source/plugins/starlists" title="💫 Starlists">💫</a> <a href="/source/plugins/stars" title="🌟 Recently starred repositories">🌟</a> <a href="/source/plugins/stock" title="💹 Stock prices">💹</a> <a href="/source/plugins/support" title="💭 GitHub Community Support">💭</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a> <a href="/source/plugins/wakatime" title="⏰ WakaTime plugin">⏰</a></td>
</tr>
<tr>
<td>👤 Users, 👥 Organizations</td>
</tr>
<tr>
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
#### ℹ️ Examples workflows
[➡️ Supported formats and inputs](metadata.yml)
## ℹ️ Examples workflows
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
template: classic
name: Example
uses: lowlighter/metrics@latest
with:
filename: metrics.classic.svg
token: ${{ secrets.METRICS_TOKEN }}
base: header, repositories
plugin_lines: 'yes'
```
<!--/examples-->

23
source/templates/community/README.md
View File

@@ -60,3 +60,26 @@ Then use HTML, CSS, and [EJS](https://github.com/mde/ejs) to create something aw
Do not hesitate to share it on [GitHub discussions](https://github.com/lowlighter/metrics/discussions)!
For more information, see [contribution guide](/CONTRIBUTING.md).
## ℹ️ Examples workflows
<!--examples-->
```yaml
name: Using a community template
uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
template: '@classic'
setup_community_templates: lowlighter/metrics@master:classic
```
```yaml
name: Using a trusted community template
uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
template: '@terminal'
setup_community_templates: lowlighter/metrics@master:terminal+trust
```
<!--/examples-->

94
source/templates/markdown/README.md
View File

@@ -1,13 +1,26 @@
<!--header-->
<table>
<tr><th colspan="2"><h3>📒 Markdown template</h3></th></tr>
<tr><td colspan="2" align="center">A template capable of rendering markdown from a given template file.</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a></td>
</tr>
<tr>
<td>👤 Users, 👥 Organizations</td>
</tr>
<tr>
<td>#️⃣ JSON, 🔠 Markdown, 🔠 Markdown (PDF)</td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.markdown.png" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
#### ℹ️ Examples workflows
<!--examples-->
<!--/examples-->
___
This template can be used to a *markdown template file* with data gathered by metrics.
Since the resulting output is a markdown file, it is possible to do additional formatting such as creating hyperlinks and adding custom texts.
@@ -116,3 +129,70 @@ The `embed()` function takes two arguments:
> 💡 The `plugin_` prefix can be dropped for convenience
> 💡 The `embed()` function does not have `🗃️ base` plugin enabled by default. To use it, it is required to explicitely pass them through `base` option.
## ℹ️ Examples workflows
<!--examples-->
```yaml
name: Example
uses: lowlighter/metrics@latest
with:
template: markdown
filename: metrics.markdown.md
markdown: metrics.markdown.template.md
config_output: markdown
token: ${{ secrets.METRICS_TOKEN }}
```
```yaml
name: Example with plugins configuration for embed use
uses: lowlighter/metrics@latest
with:
template: markdown
filename: metrics.markdown.full.md
markdown: >-
https://raw.githubusercontent.com/lowlighter/metrics/master/source/templates/markdown/example.md
config_output: markdown
plugin_activity: 'yes'
plugin_activity_limit: 7
plugin_activity_days: 0
plugin_activity_filter: issue, pr, release, fork, review, ref/create
plugin_posts: 'yes'
plugin_posts_source: dev.to
plugin_posts_descriptions: 'yes'
plugin_posts_covers: 'yes'
plugin_posts_limit: 2
plugin_rss: 'yes'
plugin_rss_source: https://news.ycombinator.com/rss
plugin_rss_limit: 4
plugin_tweets: 'yes'
plugin_tweets_token: ${{ secrets.TWITTER_TOKEN }}
plugin_tweets_user: github
plugin_tweets_attachments: 'yes'
plugin_tweets_limit: 2
plugin_topics: 'yes'
plugin_topics_limit: 24
plugin_isocalendar: 'yes'
plugin_languages: 'yes'
token: ${{ secrets.METRICS_TOKEN }}
```
```yaml
name: Example (pdf output)
uses: lowlighter/metrics@latest
with:
template: markdown
filename: metrics.markdown.pdf
markdown: >-
https://raw.githubusercontent.com/lowlighter/metrics/master/source/templates/markdown/example.pdf.md
config_output: markdown-pdf
plugin_rss: 'yes'
plugin_rss_source: https://news.ycombinator.com/rss
plugin_rss_limit: 4
plugin_isocalendar: 'yes'
config_twemoji: 'yes'
config_padding: 5%
token: ${{ secrets.METRICS_TOKEN }}
```
<!--/examples-->

53
source/templates/repository/README.md
View File

@@ -1,23 +1,42 @@
### 📘 Repository template
Template crafted for repositories, mimicking GitHub visual identity.
<!--header-->
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.repository.svg">
<img width="900" height="1" alt="">
</td>
<tr><th colspan="2"><h3>📘 Repository template</h3></th></tr>
<tr><td colspan="2" align="center">A template mimicking GitHub visual identity and specially crafted for repositories.</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/contributors" title="🏅 Repository contributors">🏅</a> <a href="/source/plugins/followup" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/introduction" title="🙋 Introduction">🙋</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/licenses" title="📜 Repository licenses">📜</a> <a href="/source/plugins/lines" title="👨‍💻 Lines of code changed">👨‍💻</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/people" title="🧑‍🤝‍🧑 People plugin">🧑‍🤝‍🧑</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects" title="🗂️ Active projects">🗂️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/sponsors" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/stargazers" title="✨ Stargazers over last weeks">✨</a> <a href="/source/plugins/stock" title="💹 Stock prices">💹</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a></td>
</tr>
<tr>
<td>📓 Repositories</td>
</tr>
<tr>
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.repository.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
#### ℹ️ Examples workflows
[➡️ Supported formats and inputs](metadata.yml)
## ℹ️ Examples workflows
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
template: classic
user: repository-owner # Optional if you're the owner of target repository and you're using your own personal token
repo: repository-name # Repository name
name: Example
uses: lowlighter/metrics@latest
with:
template: repository
filename: metrics.repository.svg
token: ${{ secrets.METRICS_BOT_TOKEN }}
user: lowlighter
repo: metrics
plugin_lines: 'yes'
plugin_followup: 'yes'
plugin_projects: 'yes'
plugin_projects_repositories: lowlighter/metrics/projects/1
```
<!--/examples-->

46
source/templates/terminal/README.md
View File

@@ -1,21 +1,37 @@
### 📙 Terminal template
Terminal template, mimicking a SSH session.
<!--header-->
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.terminal.svg">
<img width="900" height="1" alt="">
</td>
<tr><th colspan="2"><h3>📙 Terminal template</h3></th></tr>
<tr><td colspan="2" align="center">A template mimicking a SSH session.</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/plugins/gists" title="🎫 Gists">🎫</a> <a href="/source/plugins/isocalendar" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/lines" title="👨‍💻 Lines of code changed">👨‍💻</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a></td>
</tr>
<tr>
<td>👤 Users, 👥 Organizations</td>
</tr>
<tr>
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.terminal.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
#### ℹ️ Examples workflows
[➡️ Supported formats and inputs](metadata.yml)
## ℹ️ Examples workflows
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
template: terminal
name: Example
uses: lowlighter/metrics@latest
with:
template: terminal
filename: metrics.terminal.svg
token: ${{ secrets.METRICS_TOKEN }}
base: header, metadata
```
<!--/examples-->