README Sections

Module

scripts/readme_sections.py — ~1548 lines.

ReadmeSectionGenerator is the main class. It reads config.yaml from the readme_sections_settings key, fetches data, and writes sections back into README.md between HTML comment markers.

Marker block system

Sections are injected between paired HTML comments:

<!-- section-name:start -->
...generated content...
<!-- section-name:end -->

The generator reads the existing README, replaces content between markers, and writes it back. Sections not present in the README are ignored.

SVG card types

ReadmeSvgSettings controls the SVG card style used for featured repos, connect links, and blog cards:

readme_sections_settings:
  svg:
    enabled: true
    card_styles:
      default:
        variant: gh-card   # gh-card | legacy
        transparent_canvas: true
        show_title: false

Social links

ReadmeSocialLink models define the social badges in the header:

readme_sections_settings:
  social_links:
    - label: "w4w.dev"
      url: https://w4w.dev
      color: "6a9fb5"
      logo: globe

CLI

uv run python -m scripts.cli generate readme-sections --config-path ./config.yaml

Featured repos

ReadmeFeaturedRepo entries define which repos appear in the featured section:

readme_sections_settings:
  featured_repos:
    - full_name: wyattowalsh/wyattowalsh
    - full_name: wyattowalsh/listentropy