Skip to content

Commit 77890c2

Browse files
committed
docs(templates): clarification, fix typos and style
1 parent 52ca4d0 commit 77890c2

File tree

6 files changed

+14
-10
lines changed

6 files changed

+14
-10
lines changed

source/templates/classic/metadata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "📗 Classic template"
1+
name: 📗 Classic template
22
description: |
33
A template mimicking GitHub visual identity.
44
This is also the default template.

source/templates/community/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,10 @@ It is used to compute height dynamically through a [puppeteer](https://github.co
159159

160160
The default file looks like below:
161161
```yaml
162-
name: "🖼️ Template name"
162+
name: 🖼️ Template name
163163
extends: classic
164-
description: Short description
164+
description: |
165+
Short description
165166
examples:
166167
default: https://via.placeholder.com/468x60?text=No%20preview%20available
167168
supports:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "📕 Community templates"
1+
name: 📕 Community templates
22
description: |
33
A template mimicking GitHub visual identity.
44
This is also the default template.

source/templates/markdown/metadata.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
name: "📒 Markdown template"
2-
description: A template capable of rendering markdown from a given template file.
1+
name: 📒 Markdown template
2+
description: |
3+
A template capable of rendering markdown from a given template file.
34
examples:
45
default: https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.png
56
index: 3

source/templates/repository/metadata.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
name: "📘 Repository template"
2-
description: A template mimicking GitHub visual identity and specially crafted for repositories.
1+
name: 📘 Repository template
2+
description: |
3+
A template mimicking GitHub visual identity and specially crafted for repositories.
34
examples:
45
default: https://github.com/lowlighter/metrics/blob/examples/metrics.repository.svg
56
index: 1

source/templates/terminal/metadata.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
name: "📙 Terminal template"
2-
description: A template mimicking a SSH session.
1+
name: 📙 Terminal template
2+
description: |
3+
A template mimicking a SSH session.
34
examples:
45
default: https://github.com/lowlighter/metrics/blob/examples/metrics.terminal.svg
56
index: 2

0 commit comments

Comments
 (0)