From 1b646abb3ff70ef611e841fc412b826be298e894 Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Sat, 15 Jan 2022 21:20:02 -0500
Subject: [PATCH] doc(plugins/posts): update
---
source/plugins/posts/README.md | 59 ++++++++++++++++++-------------
source/plugins/posts/metadata.yml | 27 +++++++-------
2 files changed, 49 insertions(+), 37 deletions(-)
diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md
index 20a14482..55445a99 100644
--- a/source/plugins/posts/README.md
+++ b/source/plugins/posts/README.md
@@ -1,20 +1,29 @@
-### ✒️ Recent posts
-
-The recent *posts* plugin displays recent articles you wrote on an external source, like [dev.to](https://dev.to).
-
+
+
-#### ➡️ Available options
+## ➡️ Available options
@@ -23,7 +32,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts |
- Display recent posts
+ | Enable posts plugin
![]() |
@@ -33,7 +42,11 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts_source |
- Posts external source
+ | External source
+
![]() |
@@ -43,7 +56,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts_descriptions |
- Display posts descriptions
+ | Toggle posts descriptions display
![]() |
@@ -53,7 +66,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts_covers |
- Display posts cover images
+ | Toggle posts cover images display
![]() |
@@ -63,7 +76,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts_limit |
- Maximum number of posts to display
+ | Display limit
![]() |
@@ -76,7 +89,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
plugin_posts_user |
- Posts external source username
+ | External source username
![]() |
@@ -87,9 +100,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
-*[→ Full specification](metadata.yml)*
-
-#### ℹ️ Examples workflows
+## ℹ️ Examples workflows
```yaml
@@ -116,4 +127,4 @@ with:
plugin_posts_covers: 'yes'
```
-
\ No newline at end of file
+
diff --git a/source/plugins/posts/metadata.yml b/source/plugins/posts/metadata.yml
index 1eef87c5..116b983c 100644
--- a/source/plugins/posts/metadata.yml
+++ b/source/plugins/posts/metadata.yml
@@ -1,5 +1,9 @@
name: "✒️ Recent posts"
category: social
+description: This plugin displays recent articles from a specified external source.
+examples:
+ +latest posts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.svg
+ Latest posts width description and cover image: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.full.svg
index: 6
supports:
- user
@@ -8,44 +12,41 @@ supports:
scopes: []
inputs:
- # Enable or disable plugin
plugin_posts:
- description: Display recent posts
+ description: Enable posts plugin
type: boolean
default: no
- # Posts external source
plugin_posts_source:
- description: Posts external source
+ description: |
+ External source
+ - `dev.to`: [dev.to](https://dev.to)
+ - `hashnode`: [hashnode.com](https://hashnode.com)
type: string
default: ""
values:
- - dev.to # Dev.to
+ - dev.to
- hashnode
- # Display a few lines about each posts
plugin_posts_descriptions:
- description: Display posts descriptions
+ description: Toggle posts descriptions display
type: boolean
default: no
- # Display posts cover images
plugin_posts_covers:
- description: Display posts cover images
+ description: Toggle posts cover images display
type: boolean
default: no
- # Number of posts to display
plugin_posts_limit:
- description: Maximum number of posts to display
+ description: Display limit
type: number
default: 4
min: 1
max: 30
- # Username on external posts source
plugin_posts_user:
- description: Posts external source username
+ description: External source username
type: string
default: .user.login