GitHub Integration
approvedby Kirill Zhuravlev
Sync your data from GitHub into your Vault.
GitHub Integration
This Obsidian plugin imports your starred GitHub repositories into your Obsidian vault as notes with rich metadata. Keep track of interesting repositories directly in your knowledge base!
Features
- Import all starred repositories from your GitHub account
- Create notes with comprehensive repository metadata
- Organize repositories with automatic tagging (language, topics)
- Update notes with the latest repository information
- Only fetch new stars since last update (incremental updates)
Installation
- Search for "GitHub Integration" in Obsidian's community plugins browser
- Install the plugin
- Enable the plugin
Usage
Configuration
- Go to Settings → GitHub Integration
- Enter your GitHub username
- (Optional) Add a GitHub Personal Access Token for higher API rate limits
- Set a target directory where your star notes will be stored
- Click "Sync Stars" button to start sync immediately
Note Format
Each starred repository is saved as a note with the following frontmatter:
---
tags:
- type/github-star
- github/language/javascript
- github/topic/obsidian
aliases: repo-name
description: Repository description
url: https://github.com/user/repo
owner: https://github.com/user
language: JavaScript
stars: 123
created: 2023-01-01
modified: 2023-06-15
lastUpdated: 6/15/2023, 3:45:00 PM
---
Security Note
If you choose to use a GitHub API token, it will be stored in your Obsidian config. While this is generally secure, please be aware of the risks if you share your vault or config files.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Development
Prerequisites
- Node.js >= 16
- npm or yarn
Setup
- Clone this repository
- Run
npm installoryarnto install dependencies - Run
npm run devto start compilation in watch mode
Building
- Run
npm run buildto build the production version
Credits
- Built for Obsidian
Support
If you encounter any issues or have feature requests, please create an issue on the GitHub repository.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.