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

docs(templates): clarification, fix typos and style

Browse Source
This commit is contained in:
lowlighter
2022-07-04 23:19:25 -04:00
parent 52ca4d04b7
commit 77890c2a7d
6 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/templates/classic/metadata.yml
View File

@@ -1,4 +1,4 @@
name: "📗 Classic template"
name: 📗 Classic template
description: |
A template mimicking GitHub visual identity.
This is also the default template.

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

@@ -159,9 +159,10 @@ It is used to compute height dynamically through a [puppeteer](https://github.co
The default file looks like below:
```yaml
name: "🖼️ Template name"
name: 🖼️ Template name
extends: classic
description: Short description
description: |
Short description
examples:
default: https://via.placeholder.com/468x60?text=No%20preview%20available
supports:

2
source/templates/community/metadata.yml
View File

@@ -1,4 +1,4 @@
name: "📕 Community templates"
name: 📕 Community templates
description: |
A template mimicking GitHub visual identity.
This is also the default template.

5
source/templates/markdown/metadata.yml
View File

@@ -1,5 +1,6 @@
name: "📒 Markdown template"
description: A template capable of rendering markdown from a given template file.
name: 📒 Markdown template
description: |
A template capable of rendering markdown from a given template file.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.png
index: 3

5
source/templates/repository/metadata.yml
View File

@@ -1,5 +1,6 @@
name: "📘 Repository template"
description: A template mimicking GitHub visual identity and specially crafted for repositories.
name: 📘 Repository template
description: |
A template mimicking GitHub visual identity and specially crafted for repositories.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.repository.svg
index: 1

5
source/templates/terminal/metadata.yml
View File

@@ -1,5 +1,6 @@
name: "📙 Terminal template"
description: A template mimicking a SSH session.
name: 📙 Terminal template
description: |
A template mimicking a SSH session.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.terminal.svg
index: 2