|
2 | 2 |
|
3 | 3 | This plugin for [Obsidian][Obsidian] imports your GitHub stars into your vault as separate documents. So, when import is done you will be able to:
|
4 | 4 | - Create [internal links](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Internal%20links) to your starred repositories in your vault
|
5 |
| -- See a history of your stars activity |
6 |
| -- Have a index of your starred repositories groupped by programming languages |
7 |
| -- Have a index groupped by owners of your starred repos |
| 5 | +- See a history of your stars on GitHub |
| 6 | +- Have a index of your starred repositories grouped by programming languages |
| 7 | +- Have a index grouped by owners of your starred repos |
8 | 8 |
|
9 | 9 | ## Demo
|
10 | 10 |
|
|
47 | 47 | ## Roadmap to 1.0
|
48 | 48 |
|
49 | 49 | - [x] Automatically remove files related to removed stars
|
50 |
| -- [ ] i18n |
| 50 | +- [x] Incremental update |
51 | 51 | - [ ] Use Obsidian views to:
|
52 |
| - - [ ] Statistics |
53 |
| - - [ ] Full text search |
54 |
| - - [ ] Ratings |
55 |
| -- [ ] Incremental update |
| 52 | + - [ ] Make a full text search |
| 53 | + - [ ] Show statistics |
| 54 | + - [ ] Show ratings |
| 55 | +- [ ] i18n / l10n |
56 | 56 | - [ ] Fetch README file content on a starred repository page
|
57 |
| -- [ ] Fetch owner's bio or organization information on owner's page |
58 | 57 | - [ ] Global changes log
|
59 |
| -- [ ] Highlight archived or deprecated/unmaintined repositories |
| 58 | +- [ ] Highlight archived, deprecated and unmaintained repositories |
| 59 | +- [ ] Customizable templates of pages |
| 60 | +- [ ] Test suite |
60 | 61 |
|
61 | 62 | ## Implementation details
|
62 | 63 |
|
|
66 | 67 | - [SQL.js][SQL.js] (SQLite in browser via WASM)
|
67 | 68 | - [octokit.js][octokit.js] (API client for GitHub)
|
68 | 69 | - [Handlebars][Handlebars] (Templates for pages)
|
| 70 | +- [neverthrow][neverthrow] (unified error handling and result types) |
| 71 | +- [luxon][luxon] (date and time library) |
69 | 72 | - [Biome][Biome] (lint, format, etc)
|
| 73 | +- [git-cliff][git-cliff] (bump versions and change log generation) |
70 | 74 |
|
71 | 75 | ## Inspiration sources
|
72 | 76 |
|
|
80 | 84 | [Biome]: https://biomejs.dev/
|
81 | 85 | [SQL.js]: https://sql.js.org
|
82 | 86 | [octokit.js]: https://github.com/octokit/octokit.js
|
| 87 | +[neverthrow]: https://github.com/softprops/neverthrow |
| 88 | +[luxon]: https://moment.github.io/luxon/ |
83 | 89 | [Handlebars]: https://handlebarsjs.com
|
| 90 | +[git-cliff]: https://git-cliff.org/ |
0 commit comments