docs: automatically display current sponsors in README by Jocs · Pull Request #5748 · marktext/marktext · GitHub
Skip to content

docs: automatically display current sponsors in README - #5748

Merged
Jocs merged 2 commits into
developfrom
docs/current-sponsors-wall
Oct 14, 2026
Merged

Jocs merged 2 commits into
developfrom
docs/current-sponsors-wall

Conversation

@Jocs

@Jocs Jocs commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Summary

Display active, public GitHub sponsors as an avatar wall below Special Sponsor in the README. Every avatar links to https://github.com/sponsors/marktext; when no current public sponsors remain, the heading and wall are removed.

A daily and manually triggered GitHub Actions workflow fetches all sponsorship pages and commits README changes only when needed. API failures preserve the existing content. Special Sponsor stays independently maintained. No setup document is included.

Type of change

  • Documentation update
  • New feature (non-breaking, adds functionality)

Test plan

  • pnpm run lint (passed with 168 existing warnings, no errors)
  • pnpm run typecheck
  • Script lint, formatting and syntax checks
  • Local mocked checks on macOS: empty/populated transitions, placement, shared destination, attribute escaping, idempotence, pagination, private sponsor exclusion and API failures

Notes for reviewers

No related issue was supplied. No additional dependencies are needed. Live synchronization requires the repository SPONSORS_TOKEN secret after merge into develop (the default branch). The workflow uses SPONSORS_PUSH_TOKEN for checkout/push when configured, falling back to GITHUB_TOKEN. For protected develop, provide a repository-scoped token belonging to an identity allowed to push and bypass the PR requirement. SPONSORS_TOKEN is independently used to read sponsorships.

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

@Jocs
Jocs merged commit f07ea0a into develop Oct 14, 2026
11 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant