Skip to content

Commit 2e0c557

Browse files
committed
feat: wrap card embed in link to report repository
- Setup README: add Profile Card section with <a> linking to repo - README: wrap embed snippet in <a href='https://github.com/{username}/{repo}'> - All 3 theme index-page.hbs: wrap embed snippet in <a>
1 parent 54a959f commit 2e0c557

5 files changed

Lines changed: 42 additions & 20 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,13 @@ Embed an animated news ticker in your GitHub Profile README. AI-generated headli
104104
Generated automatically as part of the `render` command. Add this to your profile README:
105105

106106
```html
107-
<picture>
108-
<source media="(prefers-color-scheme: dark)" srcset="https://{username}.github.io/{repo}/card-dark.svg" />
109-
<source media="(prefers-color-scheme: light)" srcset="https://{username}.github.io/{repo}/card.svg" />
110-
<img alt="Weekly Report" src="https://{username}.github.io/{repo}/card.svg" />
111-
</picture>
107+
<a href="https://github.com/{username}/{repo}">
108+
<picture>
109+
<source media="(prefers-color-scheme: dark)" srcset="https://{username}.github.io/{repo}/card-dark.svg" />
110+
<source media="(prefers-color-scheme: light)" srcset="https://{username}.github.io/{repo}/card.svg" />
111+
<img alt="Weekly Report" src="https://{username}.github.io/{repo}/card.svg" />
112+
</picture>
113+
</a>
112114
```
113115

114116
## Features

src/cli/commands/setup/workflows.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,20 @@ Weekly GitHub activity reports for [@${opts.username}](https://github.com/${opts
192192
193193
${opts.pagesUrl}
194194
195+
## Profile Card
196+
197+
Add this to your [GitHub Profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme):
198+
199+
\`\`\`html
200+
<a href="https://github.com/${opts.repo}">
201+
<picture>
202+
<source media="(prefers-color-scheme: dark)" srcset="${opts.pagesUrl}/card-dark.svg" />
203+
<source media="(prefers-color-scheme: light)" srcset="${opts.pagesUrl}/card.svg" />
204+
<img alt="Weekly Report" src="${opts.pagesUrl}/card.svg" />
205+
</picture>
206+
</a>
207+
\`\`\`
208+
195209
## How It Works
196210
197211
1. **Daily** (automatic): A scheduled workflow collects your GitHub events at midnight (${opts.timezone}).

src/renderer/themes/brutalist/templates/index-page.hbs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,13 @@
9999
{{#if baseUrl}}
100100
<div class="embed-section">
101101
<div class="embed-label">Embed in your GitHub README</div>
102-
<pre class="embed-snippet"><code>&lt;picture&gt;
103-
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
104-
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
105-
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
106-
&lt;/picture&gt;</code></pre>
102+
<pre class="embed-snippet"><code>&lt;a href="https://github.com/{your-repo}"&gt;
103+
&lt;picture&gt;
104+
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
105+
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
106+
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
107+
&lt;/picture&gt;
108+
&lt;/a&gt;</code></pre>
107109
</div>
108110
{{/if}}
109111

src/renderer/themes/editorial/templates/index-page.hbs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,13 @@
6464
{{#if baseUrl}}
6565
<div class="embed-section">
6666
<div class="embed-label">Embed in your GitHub README</div>
67-
<pre class="embed-snippet"><code>&lt;picture&gt;
68-
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
69-
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
70-
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
71-
&lt;/picture&gt;</code></pre>
67+
<pre class="embed-snippet"><code>&lt;a href="https://github.com/{your-repo}"&gt;
68+
&lt;picture&gt;
69+
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
70+
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
71+
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
72+
&lt;/picture&gt;
73+
&lt;/a&gt;</code></pre>
7274
</div>
7375
{{/if}}
7476

src/renderer/themes/minimal/templates/index-page.hbs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,13 @@
6464
{{#if baseUrl}}
6565
<div class="embed-section">
6666
<div class="embed-label">Embed in your GitHub README</div>
67-
<pre class="embed-snippet"><code>&lt;picture&gt;
68-
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
69-
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
70-
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
71-
&lt;/picture&gt;</code></pre>
67+
<pre class="embed-snippet"><code>&lt;a href="https://github.com/{your-repo}"&gt;
68+
&lt;picture&gt;
69+
&lt;source media="(prefers-color-scheme: dark)" srcset="{{baseUrl}}/card-dark.svg" /&gt;
70+
&lt;source media="(prefers-color-scheme: light)" srcset="{{baseUrl}}/card.svg" /&gt;
71+
&lt;img alt="Weekly Report" src="{{baseUrl}}/card.svg" /&gt;
72+
&lt;/picture&gt;
73+
&lt;/a&gt;</code></pre>
7274
</div>
7375
{{/if}}
7476

0 commit comments

Comments
 (0)