From 77890c2a7dd654f12dd8acb3bb4547f42ff1bf42 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Mon, 4 Jul 2022 23:19:25 -0400 Subject: [PATCH] docs(templates): clarification, fix typos and style --- source/templates/classic/metadata.yml | 2 +- source/templates/community/README.md | 5 +++-- source/templates/community/metadata.yml | 2 +- source/templates/markdown/metadata.yml | 5 +++-- source/templates/repository/metadata.yml | 5 +++-- source/templates/terminal/metadata.yml | 5 +++-- 6 files changed, 14 insertions(+), 10 deletions(-) diff --git a/source/templates/classic/metadata.yml b/source/templates/classic/metadata.yml index 5f258c6e..fa29f31c 100644 --- a/source/templates/classic/metadata.yml +++ b/source/templates/classic/metadata.yml @@ -1,4 +1,4 @@ -name: "📗 Classic template" +name: 📗 Classic template description: | A template mimicking GitHub visual identity. This is also the default template. diff --git a/source/templates/community/README.md b/source/templates/community/README.md index 63e5b84b..de94102a 100644 --- a/source/templates/community/README.md +++ b/source/templates/community/README.md @@ -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: diff --git a/source/templates/community/metadata.yml b/source/templates/community/metadata.yml index d59715e6..e724f1cb 100644 --- a/source/templates/community/metadata.yml +++ b/source/templates/community/metadata.yml @@ -1,4 +1,4 @@ -name: "📕 Community templates" +name: 📕 Community templates description: | A template mimicking GitHub visual identity. This is also the default template. diff --git a/source/templates/markdown/metadata.yml b/source/templates/markdown/metadata.yml index 56ca2848..e9b0d7e7 100644 --- a/source/templates/markdown/metadata.yml +++ b/source/templates/markdown/metadata.yml @@ -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 diff --git a/source/templates/repository/metadata.yml b/source/templates/repository/metadata.yml index fc67c209..7ca186f2 100644 --- a/source/templates/repository/metadata.yml +++ b/source/templates/repository/metadata.yml @@ -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 diff --git a/source/templates/terminal/metadata.yml b/source/templates/terminal/metadata.yml index 624afa96..8bae47df 100644 --- a/source/templates/terminal/metadata.yml +++ b/source/templates/terminal/metadata.yml @@ -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