Skip to content

Commit 6e13859

Browse files
hesreallyhimclaude
andcommitted
feat: add banner image to Awesome style README
Add centered banner image below the style selector in the Awesome README variant. The image path is dynamically resolved based on the output location, so it works correctly for both the root README.md and the alternative in README_ALTERNATIVES/. - Add {{BANNER_IMAGE}} placeholder to Awesome template - Add generate_banner_image() method to base generator (returns empty by default) - Override in AwesomeReadmeGenerator with path resolution logic Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 349ab82 commit 6e13859

File tree

5 files changed

+35
-0
lines changed

5 files changed

+35
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
<a href="README_ALTERNATIVES/README_FLAT_ALL_AZ.md"><img src="assets/badge-style-flat.svg" alt="Flat" height="28"></a>
88
</p>
99

10+
<p align="center">
11+
<img src=".claude/awesome-claude-code-social-clawd-2.png" alt="Awesome Claude Code" width="600">
12+
</p>
13+
1014
# Awesome Claude Code
1115

1216
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

README_ALTERNATIVES/README_AWESOME.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
<a href="README_FLAT_ALL_AZ.md"><img src="../assets/badge-style-flat.svg" alt="Flat" height="28"></a>
88
</p>
99

10+
<p align="center">
11+
<img src="../.claude/awesome-claude-code-social-clawd-2.png" alt="Awesome Claude Code" width="600">
12+
</p>
13+
1014
# Awesome Claude Code
1115

1216
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

scripts/readme/generators/awesome.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
"""Awesome README generator implementation."""
22

3+
import os
4+
from pathlib import Path
5+
36
from scripts.readme.generators.base import ReadmeGenerator
47
from scripts.readme.markup.awesome import (
58
format_resource_entry as format_awesome_resource_entry,
@@ -16,6 +19,7 @@
1619
from scripts.readme.markup.awesome import (
1720
generate_weekly_section as generate_awesome_weekly_section,
1821
)
22+
from scripts.utils.repo_root import find_repo_root
1923

2024

2125
class AwesomeReadmeGenerator(ReadmeGenerator):
@@ -53,3 +57,16 @@ def generate_section_content(self, category: dict, section_index: int) -> str:
5357
def generate_repo_ticker(self) -> str:
5458
"""Generate the awesome-style animated SVG repo ticker."""
5559
return generate_awesome_repo_ticker()
60+
61+
def generate_banner_image(self, output_path: Path) -> str:
62+
"""Generate centered banner image for Awesome style README."""
63+
repo_root = find_repo_root(Path(__file__))
64+
banner_file = ".claude/awesome-claude-code-social-clawd-2.png"
65+
66+
# Calculate relative path from output location to banner
67+
banner_abs = repo_root / banner_file
68+
rel_path = Path(os.path.relpath(banner_abs, start=output_path.parent)).as_posix()
69+
70+
return f"""<p align="center">
71+
<img src="{rel_path}" alt="Awesome Claude Code" width="600">
72+
</p>"""

scripts/readme/generators/base.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,11 @@ def generate_repo_ticker(self) -> str:
164164
"""Generate the repo ticker section."""
165165
return ""
166166

167+
def generate_banner_image(self, output_path: Path) -> str:
168+
"""Generate banner image HTML. Override in subclasses to add a banner."""
169+
_ = output_path
170+
return ""
171+
167172
def load_csv_data(self) -> list[dict]:
168173
"""Load and filter active resources from CSV."""
169174
csv_data = []
@@ -241,6 +246,9 @@ def generate(self, output_path: str | None = None) -> tuple[int, str | None]:
241246
"{{STYLE_SELECTOR}}", self.get_style_selector(Path(output_path))
242247
)
243248
readme_content = readme_content.replace("{{REPO_TICKER}}", self.generate_repo_ticker())
249+
readme_content = readme_content.replace(
250+
"{{BANNER_IMAGE}}", self.generate_banner_image(Path(output_path))
251+
)
244252

245253
readme_content = ensure_generated_header(readme_content)
246254
readme_content = resolve_asset_tokens(

templates/README_AWESOME.template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{{STYLE_SELECTOR}}
22

3+
{{BANNER_IMAGE}}
4+
35
# Awesome Claude Code
46

57
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

0 commit comments

Comments
 (0)