Skip to content

Add path parameter to github-card shortcode #17469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dirien merged 1 commit into from
Feb 10, 2026
Merged

Add path parameter to github-card shortcode #17469

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions layouts/shortcodes/github-card.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,27 @@

Usage:
{{< github-card repo="owner/repo" >}}
{{< github-card repo="owner/repo" path="example-folder" >}}
{{< github-card repo="owner/repo" branch="master" path="example-folder" >}}

Parameters:
- repo (required): The GitHub repository in "owner/repo" format
- path (optional): Path within the repo (e.g., "example-folder")
- branch (optional): Branch name, defaults to "main"
*/}}

{{ $repo := .Get "repo" }}
{{ $path := .Get "path" }}
{{ $branch := .Get "branch" | default "main" }}

{{ if $repo }}
<a href="https://github.com/{{ $repo }}" target="_blank" rel="noopener noreferrer" class="github-card">
{{ $linkUrl := printf "https://github.com/%s" $repo }}
{{ $displayUrl := printf "github.com/%s" $repo }}
{{ if $path }}
{{ $linkUrl = printf "https://github.com/%s/tree/%s/%s" $repo $branch $path }}
{{ $displayUrl = printf "github.com/%s/tree/%s/%s" $repo $branch $path }}
{{ end }}
<a href="{{ $linkUrl }}" target="_blank" rel="noopener noreferrer" class="github-card">
<img
src="https://opengraph.githubassets.com/1/{{ $repo }}"
alt="GitHub repository: {{ $repo }}"
Expand All @@ -24,7 +36,7 @@
<div class="github-card-content">
<div class="github-card-domain">
<i class="fab fa-github github-card-icon"></i>
github.com/{{ $repo }}
{{ $displayUrl }}
</div>
</div>
</a>
Expand Down
Loading