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
19 commits 1 branch 10 tags 204 KiB
TypeScript 94.6%
JavaScript 3.6%
CSS 1.8%
Find a file
flyingnobita 0faf143556
chore: release 1.3.0
2026-03-19 15:25:49 +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
CHANGELOG.md chore: release 1.3.0 2026-03-19 15:25:49 +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 feat: remove configurable display format, hardcode to ⭐ {stars} 2026-03-19 15:25:43 +08:00
manifest.json chore: release 1.3.0 2026-03-19 15:25:49 +08:00
obsidian-github-stars-screenshot.png Initial commit 2025-03-15 01:35:24 +08:00
package-lock.json 1.2.1 2026-03-18 17:26:37 +08:00
package.json chore: release 1.3.0 2026-03-19 15:25:49 +08:00
README.md chore: release 1.3.0 2026-03-19 15:25:49 +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 chore: release 1.3.0 2026-03-19 15:25:49 +08:00

README.md

GitHub Stars Plugin

License Version Obsidian Downloads

An Obsidian plugin that automatically displays GitHub star counts next to repository links in your notes — in both Reading View and Live Preview. Star counts can also be embedded directly into your markdown, making them visible outside Obsidian.

✨ 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
  • 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
Star counts displayed inline next to GitHub repository links in Reading View.

📦 Installation

  1. Open Obsidian Settings → Community plugins
  2. Disable Safe mode if prompted
  3. Click Browse and search for "GitHub Stars"
  4. Click Install, then Enable

⚙️ Configuration

The plugin can be configured in the Settings tab:

  • Cache Expiry: Time in minutes before the GitHub star count cache expires (default: 1440 minutes / 1 day)
  • Number Format: Choose between full numbers (e.g., 1,234) or abbreviated format (e.g., 1.2k)
  • GitHub API Token: Optional personal access token to increase the API rate limit from 60 to 5,000 requests per hour. To generate one:
    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

💻 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

❤️ Support This Project

You can support this project by:

  • ⭐ Starring this repo
  • 🔀 Making a pull request

📄 License

MIT © Flying Nobita