Skip to content

Commit 5c7cc63

Browse files
Merge pull request #112 from deariary/docs/card-readme-fix
fix: use GitHub Pages URL for card SVG animation in README
2 parents c0f6c1b + 0bd9239 commit 5c7cc63

6 files changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ with:
9696
Embed an animated news ticker in your GitHub Profile README. AI-generated headlines scroll with dramatic labels.
9797
9898
<picture>
99-
<source media="(prefers-color-scheme: dark)" srcset="examples/card-dark.svg" />
100-
<source media="(prefers-color-scheme: light)" srcset="examples/card.svg" />
101-
<img alt="Weekly News Ticker" src="examples/card.svg" />
99+
<source media="(prefers-color-scheme: dark)" srcset="https://deariary.github.io/github-weekly-reporter/screenshots/card-dark.svg" />
100+
<source media="(prefers-color-scheme: light)" srcset="https://deariary.github.io/github-weekly-reporter/screenshots/card.svg" />
101+
<img alt="Weekly News Ticker" src="https://deariary.github.io/github-weekly-reporter/screenshots/card.svg" />
102102
</picture>
103103
104104
Generated automatically as part of the `render` command. Add this to your profile README:

scripts/generate-preview-index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ const html = `<!DOCTYPE html>
245245
<h2>Profile Card</h2>
246246
<p class="lead">Embed an animated news ticker in your GitHub Profile README. AI writes the headlines.</p>
247247
<div style="border:1px solid #222;border-radius:6px;overflow:hidden;margin-bottom:1rem;">
248-
<img src="examples/card-dark.svg" alt="Weekly News Ticker" style="width:100%;display:block;" />
248+
<img src="screenshots/card-dark.svg" alt="Weekly News Ticker" style="width:100%;display:block;" />
249249
</div>
250250
<p class="qs-note" style="margin-top:0.5rem;">
251251
Generated automatically with each weekly report. Headlines use dramatic, tongue-in-cheek labels like a TV news broadcast.

scripts/generate-preview.sh

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ done
3636
# Copy theme screenshots for LP
3737
cp -r scripts/screenshots "$OUT_DIR/screenshots"
3838

39-
# Copy example card SVGs for LP
40-
mkdir -p "$OUT_DIR/examples"
41-
cp examples/card.svg examples/card-dark.svg "$OUT_DIR/examples/"
39+
# Copy card SVGs for LP and README
40+
cp scripts/screenshots/card.svg scripts/screenshots/card-dark.svg "$OUT_DIR/screenshots/"
4241

4342
# Generate top-level index
4443
node scripts/generate-preview-index.js "$OUT_DIR" "$BASE_URL" "$THEMES" "$LANGS"
Lines changed: 4 additions & 4 deletions
Loading
Lines changed: 4 additions & 4 deletions
Loading

src/renderer/card.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ const buildSVG = (data: CardData, colors: CardColors): string => {
126126
100% { transform: translateX(-${totalWidth.toFixed(0)}px); }
127127
}`;
128128

129-
const font = '-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif';
129+
const font = "-apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif";
130130
const topH = HEIGHT - TICKER_H;
131131
const midY = topH / 2 + 4;
132132

0 commit comments

Comments
 (0)