Movatterモバイル変換

DenverCoder1/github-readme-youtube-cardsPublic

NotificationsYou must be signed in to change notification settings
Fork54
Star235

Workflow for displaying recent YouTube videos as SVG cards in your readme

ytcards.demolab.com

License

MIT license

235 stars 54 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 233 Commits
.github		.github
api		api
tests		tests
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
action.py		action.py
action.yml		action.yml
pyproject.toml		pyproject.toml
requirements-action.txt		requirements-action.txt
requirements-dev.txt		requirements-dev.txt
requirements.txt		requirements.txt
tox.ini		tox.ini
vercel.json		vercel.json

Repository files navigation

GitHub Readme YouTube Cards

Workflow for displaying recent YouTube videos as SVG cards in your readme

Basic Usage

Add the following snippet to your markdown file where you want the cards to appear.

<!-- BEGIN YOUTUBE-CARDS --><!-- END YOUTUBE-CARDS -->

In your repo, create a.github folder and inside create a folder namedworkflows if it does not exist. Then create a file in your.github/workflows/ folder and give it a name such asyoutube-cards.yml with the following contents.

name:GitHub Readme YouTube Cardson:schedule:# Runs every hour, on the hour    -cron:"0 * * * *"workflow_dispatch:jobs:build:runs-on:ubuntu-latest# Allow the job to commit to the repositorypermissions:contents:write# Run the GitHub Readme YouTube Cards actionsteps:      -uses:DenverCoder1/github-readme-youtube-cards@mainwith:channel_id:UCipSxT7a3rn81vGLw9lqRkg

Make sure to change thechannel_id toyour YouTube channel ID.
Thecron expression in the example above is set to run at the top of every hour. The first time, you may want totrigger the workflow manually.
You're done! Star the repo and share it with friends! ⭐

See below foradvanced configuration.

Live Example

How To Self-Host GitHub Readme Streak Stats on Vercel

Automatically Deploy to Fly.io with GitHub Actions

Hosting a Python Discord Bot for Free with Fly.io

Making a Wordle Clone Discord Bot with Python (Nextcord)

Run Open Source Code in Seconds with GitPod

Advanced Configuration

Seeaction.yml for full details.

Check out theWiki for frequently asked questions.

Inputs

Option	Description	Default
`channel_id`	The channel ID to use for the feed^📺	""
`playlist_id`	The playlist ID to use for the feed^📺	""
`lang`	The locale for views and timestamps^💬	"en"
`comment_tag_name`	The text in the comment tag for replacing content	"YOUTUBE-CARDS"
`youtube_api_key`	The API key to use for features marked with 🔑	""
`max_videos`	The maximum number of videos to display	6
`base_url`	The base URL to use for the cards	"https://ytcards.demolab.com/"
`card_width`	The width of the SVG cards in pixels	250
`border_radius`	The border radius of the SVG cards	5
`background_color`	The background color of the SVG cards	"#0d1117"
`title_color`	The color of the title text	"#ffffff"
`stats_color`	The color of the stats text	"#dedede"
`theme_context_light`	JSON object with light mode colors^🎨	"{}"
`theme_context_dark`	JSON object with dark mode colors^🎨	"{}"
`max_title_lines`	The maximum number of lines to use for the title	1
`show_duration`^🔑	Whether to show the duration of the videos	"false"
`author_name`	The name of the commit author	"GitHub Actions"
`author_email`	The email address of the commit author	"41898282+github-actions[bot]@users.noreply.github.com"
`commit_message`	The commit message to use for the commit	"docs(readme): Update YouTube cards"
`readme_path`	The path to the Markdown or HTML file to update	"README.md"
`output_only`	Whether to skip writing to the readme file	"false"
`output_type`	The output syntax to use ("markdown" or "html")	"markdown"

^📺 A Channel ID or Playlist ID is required. SeeHow to Locate Your Channel ID in the wiki for more information. To filter videos by type such as removing shorts or showing only popular videos, seeHow to Filter Videos by Type.

^🔑 Some features require a YouTube API key. SeeSetting Up the Action with a YouTube API Key in the wiki for more information.

^🎨 SeeSetting Theme Contexts for Light and Dark Mode in the wiki for more information.

^💬 Seethis directory for a list of locales with the word "views" translated. The timestamps will still be translated usingBabel even if a translation file is not present. Seeissue #48 for info on contributing translations.

Outputs

Output	Description
`markdown`	The generated Markdown or HTML used for updating the README file
`committed`	Whether the action has created a commit (`true` or`false`)
`commit_long_sha`	The full SHA of the commit that has just been created
`commit_sha`	The short 7-character SHA of the commit that has just been created
`pushed`	Whether the action has pushed to the remote (`true` or`false`)

SeeUsing the Markdown as an Action Output for more information.

Example Workflow

This is an advanced example showing the available options. All options are optional exceptchannel_id.

name:GitHub Readme YouTube Cardson:schedule:# Runs every hour, on the hour    -cron:"0 * * * *"workflow_dispatch:jobs:build:runs-on:ubuntu-latest# Allow the job to commit to the repositorypermissions:contents:write# Run the GitHub Readme YouTube Cards actionsteps:      -uses:DenverCoder1/github-readme-youtube-cards@mainwith:channel_id:UCipSxT7a3rn81vGLw9lqRkglang:encomment_tag_name:YOUTUBE-CARDSyoutube_api_key:${{ secrets.YOUTUBE_API_KEY }}# Configured in Actions Secrets (see Wiki)max_videos:6base_url:https://ytcards.demolab.com/card_width:250border_radius:5background_color:"#0d1117"title_color:"#ffffff"stats_color:"#dedede"theme_context_light:'{ "background_color": "#ffffff", "title_color": "#24292f", "stats_color": "#57606a" }'theme_context_dark:'{ "background_color": "#0d1117", "title_color": "#ffffff", "stats_color": "#dedede" }'max_title_lines:2show_duration:true# Requires YouTube API Key (see Wiki)author_name:GitHub Actionsauthor_email:41898282+github-actions[bot]@users.noreply.github.comcommit_message:"docs(readme): Update YouTube cards"readme_path:README.mdoutput_only:falseoutput_type:markdown

Example Playlist Workflow

This is an example workflow for using a playlist instead of a channel.

name:GitHub Readme YouTube Cardson:schedule:# Runs every hour, on the hour    -cron:"0 * * * *"workflow_dispatch:jobs:build:runs-on:ubuntu-latest# Allow the job to commit to the repositorypermissions:contents:write# Run the GitHub Readme YouTube Cards actionsteps:      -uses:DenverCoder1/github-readme-youtube-cards@mainwith:playlist_id:PL9YUC9AZJGFFAErr_ZdK2FV7sklMm2K0J