obsidian-plugin/flyingnobita_obsidian-github-stars
1
0
Fork 0
mirror of https://github.com/flyingnobita/obsidian-github-stars.git synced 2026-07-22 05:42:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
4 commits 1 branch 10 tags 204 KiB
TypeScript 94.6%
JavaScript 3.6%
CSS 1.8%
Find a file
flyingnobita 2ce228c685 fix: Fix 1) Remove Obsidian from README.md 2) Sentence case 3) use requestURL from Obsidian API
2025-03-30 13:43:13 +08:00
.editorconfig Initial commit 2025-03-15 01:35:24 +08:00
.eslintignore Initial commit 2025-03-15 01:35:24 +08:00
.eslintrc Initial commit 2025-03-15 01:35:24 +08:00
.gitignore Initial commit 2025-03-15 01:35:24 +08:00
.hotreload Initial commit 2025-03-15 01:35:24 +08:00
.npmrc Initial commit 2025-03-15 01:35:24 +08:00
esbuild.config.mjs Initial commit 2025-03-15 01:35:24 +08:00
LICENSE Initial commit 2025-03-15 01:35:24 +08:00
main.ts fix: Fix 1) Remove Obsidian from README.md 2) Sentence case 3) use requestURL from Obsidian API 2025-03-30 13:43:13 +08:00
manifest.json Remove obsidian from plugin-id 2025-03-15 01:47:15 +08:00
obsidian-github-stars-screenshot.png Initial commit 2025-03-15 01:35:24 +08:00
package-lock.json Initial commit 2025-03-15 01:35:24 +08:00
package.json Initial commit 2025-03-15 01:35:24 +08:00
README.md fix: Fix 1) Remove Obsidian from README.md 2) Sentence case 3) use requestURL from Obsidian API 2025-03-30 13:43:13 +08:00
styles.css Initial commit 2025-03-15 01:35:24 +08:00
tsconfig.json Initial commit 2025-03-15 01:35:24 +08:00
version-bump.mjs Initial commit 2025-03-15 01:35:24 +08:00
versions.json Initial commit 2025-03-15 01:35:24 +08:00

README.md

GitHub Stars Plugin

Display the number of stars next to GitHub repository links.

Note: This plugin currently only display the stars in Reading View. In the future I hope to support it in Live Preview as well.

Features

  • Automatically detects GitHub repository URLs in your notes
  • Displays the star count next to each GitHub repository link
  • 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)
  • Command to refresh star counts for the current note

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 GitHub Stars for Current Note: Refreshes all GitHub star counts in the current note
  • Clear GitHub Stars Cache: Clears the cached star counts

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

Roadmap

  • Support for Live Preview mode

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.