obsidian-plugin/flyingnobita_obsidian-github-stars
1
0
Fork 0
mirror of https://github.com/flyingnobita/obsidian-github-stars.git synced 2026-07-22 12:20:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
flyingnobita_obsidian-githu.../README.md
flyingnobita 2a7c331e0f
docs: update README for Live Preview and embed features 
- Remove outdated Live Preview roadmap item (now implemented)
- Document embed/remove star counts commands
- Update feature list

Co-Authored-By: Oz <oz-agent@warp.dev>
2026-03-18 17:02:08 +08:00

2.6 KiB
Raw Blame History

GitHub Stars Plugin

Display the number of stars next to GitHub repository links.

Features

  • Automatically detects GitHub repository URLs in your notes
  • Displays the star count next to each GitHub repository link in both Reading View and Live Preview
  • Embed star counts directly into your markdown files so they are visible outside Obsidian
  • Caches star counts to minimize API requests
  • Configurable display format for star counts
  • Optional GitHub API token support for higher rate limits
  • Supports abbreviated number formatting (e.g., 1.2k instead of 1,234)
  • Commands to refresh, embed, and remove star counts

Examples

When you include a GitHub repository URL in your notes, the plugin will automatically enhance it to show the star count:

Obsidian GitHub Stars Plugin Screenshot

Configuration

The plugin can be configured in the Settings tab:

  • Cache Expiry: Time in minutes before the GitHub star count cache expires (default: 60 minutes)
  • Display Format: Format for displaying star counts. Use {stars} as a placeholder for the number (default: ⭐ {stars})
  • Number Format: Choose between full numbers (e.g., 1,234) or abbreviated format (e.g., 1.2k)
  • GitHub API Token: Optional personal access token for GitHub API to increase rate limits

Commands

The plugin adds the following commands:

  • Refresh for current note: Refreshes all GitHub star counts in the current note
  • Clear cache: Clears the cached star counts
  • Embed star counts in current note: Writes star counts (e.g. ⭐ 1.2k) directly into the markdown file after each GitHub link. Re-running updates existing counts.
  • Remove embedded star counts from current note: Strips all embedded star counts from the file

GitHub API Rate Limits

The GitHub API has rate limits for unauthenticated requests (60 requests per hour). If you use GitHub extensively in your notes, you might want to add a GitHub personal access token in the plugin settings to increase this limit (5,000 requests per hour for authenticated requests).

To create a GitHub personal access token:

  1. Go to GitHub Settings > Developer settings > Personal access tokens
  2. Click "Generate new token"
  3. Give it a name and select the "public_repo" scope
  4. Click "Generate token"
  5. Copy the token and paste it in the plugin settings

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.