Files
metrics/source/plugins/posts/README.md

2.0 KiB
Raw Blame History

✒️ Recent posts

The recent posts plugin displays recent articles you wrote on an external source, like dev.to.

Latest posts
Latest posts width description and cover image

➡️ Available options

Option Type (format) [default] {allowed values} Description
plugin_posts boolean [no] Display recent posts
plugin_posts_source string [] {"dev.to", "hashnode"} Posts external source
plugin_posts_descriptions boolean [no] Display posts descriptions
plugin_posts_covers boolean [no] Display posts cover images
plugin_posts_limit number [4] {1 ≤ 𝑥 ≤ 30} Maximum number of posts to display
plugin_posts_user string [.user.login] Posts external source username

Legend for option icons:

  • 🔐 Value should be stored in repository secrets
  • New feature currently in testing on master/main

→ Full specification

Examples workflows

name: Recent posts
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.posts.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_posts: 'yes'
  plugin_posts_source: dev.to

name: Recent posts with descriptions and cover images
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.posts.full.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_posts: 'yes'
  plugin_posts_source: dev.to
  plugin_posts_descriptions: 'yes'
  plugin_posts_covers: 'yes'