Skip to content

Commit a48cec8

Browse files
committed
chore: update README
1 parent c68984c commit a48cec8

1 file changed

Lines changed: 23 additions & 10 deletions

File tree

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# GitHub Issues for Obsidian
1+
# GitHub & GitLab Issues for Obsidian
22

3-
An Obsidian plugin that integrates with GitHub to track issues and pull requests directly in your vault.
3+
An Obsidian plugin that integrates with GitHub and GitLab to track issues and pull requests directly in your vault.
44

55

66
>The configurations are heavily inspired by https://github.com/schaier-io, including some specific settings. However, I had already started working on my prototype before I discovered the plugin, and had initially even given it a similar name.
@@ -11,25 +11,34 @@ Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/w
1111
## Features
1212

1313
### Issue & Pull Request Tracking
14-
- Track issues and pull requests from multiple GitHub repositories
15-
- Automatically sync GitHub data on startup (configurable)
14+
- Track issues and pull requests from multiple GitHub and GitLab repositories
15+
- Automatically sync data on startup (configurable)
1616
- Background sync at configurable intervals
1717
- Filter by labels, assignees, and reviewers
1818
- Include or exclude closed issues/PRs
1919
- Automatic cleanup of old closed items
2020

21+
### GitLab Support
22+
- Full support for GitLab Issues and Merge Requests
23+
- Works with self-hosted GitLab instances
24+
- Multiple GitLab instances can be configured simultaneously
25+
2126
### GitHub Projects v2 Integration
2227
- Track GitHub Projects across repositories
2328
- Kanban board view for project visualization
2429
- Custom field support (status, priority, iteration)
2530
- Project-specific filtering and organization
2631

2732
### Sub-Issues Support
28-
- Track GitHub sub-issues (parent/child relationships)
33+
- Track sub-issues for both GitHub and GitLab (parent/child relationships)
2934
- Display sub-issues list with status indicators
3035
- Navigate between parent and child issues
3136
- Progress tracking with completion percentage
3237

38+
### Settings Profiles
39+
- Central configuration for folders, templates, sync behaviour, and filters
40+
- Assign one profile to multiple repositories instead of configuring each one individually
41+
3342
### Markdown Notes
3443
- Create markdown notes for each issue or PR
3544
- Customizable filename templates with variables
@@ -57,16 +66,20 @@ Check out the [documentation](https://github.com/LonoxX/obsidian-github-issues/w
5766

5867
## Configuration
5968

60-
1. Create a new GitHub token with the `repo` and `read:org` permissions
69+
### GitHub
70+
1. Create a GitHub token with `repo` and `read:org` permissions
6171
[GitHub Settings > Developer Settings > Personal access tokens](https://github.com/settings/tokens)
62-
2. Configure the plugin in Obsidian settings:
63-
- Paste your GitHub token in the **GitHub Token** field
64-
- Adjust additional settings as needed
72+
2. Paste the token in **Settings → GitHub & GitLab Issues → GitHub Token**
73+
74+
### GitLab
75+
1. Create a GitLab Personal Access Token with `read_api` scope
76+
→ GitLab → Preferences → Access Tokens
77+
2. Enable the GitLab provider in **Settings → Providers** and paste your token
6578

6679
## Adding Repositories
6780

6881
1. Open the plugin settings in Obsidian
69-
2. Add repositories by entering the full GitHub repository path (e.g., `lonoxx/obsidian-github-issues`),
82+
2. Add repositories by entering the full repository path (e.g., `lonoxx/obsidian-github-issues`),
7083
or use the repository browser to select one or multiple repositories
7184
3. Click **Add Repository** or **Add Selected Repositories**
7285
4. The plugin will automatically fetch issues from the configured repositories

0 commit comments

Comments
 (0)