|
1 | | -<img src="https://user-images.githubusercontent.com/4745789/131798196-7946c290-b663-48ac-b7ae-bf9de27bb20c.png" alt="Obsidian HackerNews Plugin" width="400" /> |
2 | | - |
3 | | -# Obsidian HackerNews [](https://github.com/arpitbbhayani/obsidian-hackernews/releases)  |
4 | | - |
5 | | -The plugin periodically fetches and displays top stories from [HackerNews](https://news.ycombinator.com/) in an [Obsidian](https://obsidian.md) pane. Some of the best stories, blogs, news, and resources are shared on [HackerNews](https://news.ycombinator.com/), and this plugin helps stay updated while using Obsidian. |
6 | | - |
7 | | -# Installation |
8 | | - |
9 | | -## Through Community Plugins |
10 | | - |
11 | | -> The plugin is [submitted](https://github.com/obsidianmd/obsidian-releases/pull/464) to be published as the official Community Plugin. Once the Obsidian team approves it, you can install the plugin through the following steps. |
12 | | -
|
13 | | - - Open the *Command Palette* (default: `ctrl` + `p`), |
14 | | - - Search for *Open HackerNews* and run the command. |
15 | | - - You will see that a new View appears in the right Sidebar of Obsidian. |
16 | | - - Drag and drop like any other pane and power-up your Obsidian. |
17 | | - |
18 | | - |
19 | | -## Manual Install |
20 | | - |
21 | | -You can also install this plugin manually through the following steps |
22 | | - - Create the folder `obsidian-hackernews` under the path `.obsidian/plugins` |
23 | | - - Download `main.js` and `manifest.json` from the [latest release](https://github.com/arpitbbhayani/obsidian-hackernews/releases) and place them in the folder `.obsidian/plugins/obsidian-hackernews` |
24 | | - - Reload the Installed plugins under Community Plugins tab, and you would see HackerNews plugin now in the list. |
25 | | - - Enable this HackerNews plugin and see it in action. |
26 | | - |
27 | | -# Is this plugin for you? |
28 | | - |
29 | | -This plugin is for you if you use [Obsidian](https://obsidian.md) and |
30 | | - - are a passionate engineer |
31 | | - - want to discover amazing articles, resources, and projects |
32 | | - - want to stay updated with the happenings in the tech world |
33 | | - |
34 | | - |
35 | | -# Why I created this plugin? |
36 | | -I love reading technical articles and stay updated with the latest happenings in the tech world, and I find [HackerNews](https://news.ycombinator.com/) ideal for this. I have read some of the best articles and found amazing open source libraries through it, and hence I always like to keep a clock eye on HackerNews. |
37 | | - |
38 | | -On Mac, I used [YCombinator Plugin](https://github.com/martinsirbe/ycombinator-bitbar) on [BitBar](https://xbarapp.com/), which is very similar and shows one top story from [HackerNews](https://news.ycombinator.com/) in the top menu bar. If the title is enticing enough, I can always learn more about it by clicking the item. This is a great way for me to discover the best resources out there. |
39 | | - |
40 | | -Recently, I switched to a Windows machine and found it not having a similar utility; plus, writing a widget for Windows is a mess. When I discovered Obsidian, I found myself using it quite frequently. So I thought of creating a plugin similar to the [YCombinator Plugin](https://github.com/martinsirbe/ycombinator-bitbar) to fetch random top story from HackerNews and show it to me in the side pane. |
41 | | - |
42 | | -This is how this Plugin was conceptualized, and now my Obsidian workspace looks like this. |
43 | | - |
44 | | - |
45 | | - |
46 | | -# Privacy |
47 | | -This plugin makes calls to the following APIs to fetch the top stories from HackerNews |
48 | | - - [https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty](https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty) |
49 | | - - [https://hacker-news.firebaseio.com/v0/item/8863.json?print=pretty](https://hacker-news.firebaseio.com/v0/item/8863.json?print=pretty) |
50 | | - |
51 | | -The API calls are mere GET calls that do not pass any client-side information through the API to `hacker-news.firebaseio.com`. |
52 | | - |
53 | | -# About me |
54 | | - |
55 | | -Hello, I am [Arpit Bhayani](https://arpitbhayani.me/) - a CS Engineer, Educator, and a Polymath. I love everything around Computer Science, Programming, Mathematics, and Art. You can find me on [Twitter](https://twitter.com/arpit_bhayani), tweeting mostly about nerdy stuff. |
56 | | - |
57 | | -In January 2020, I started my [newsletter](https://arpitbhayani.me/newsletter), where I write and share an essay about Distributed Systems, System Design, Programming languages internals, and deep dives on some super-clever algorithms. The newsletter currently has close to **2000+** subscribers. |
58 | | - |
59 | | -I have been running a niche [Cohort-based Course](https://arpitbhayani.me/masterclass) on System Design to help engineering become better at designing _scalable_, _fault-tolerant_, and _highly available_ systems. |
60 | | - |
61 | | -You can choose to support me in everything I do by sponsoring this plugin. |
62 | | - |
63 | | -<a href="https://www.buymeacoffee.com/arpitbhayani"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=arpitbhayani&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00"></a> |
64 | | - |
| 1 | +<img src="https://user-images.githubusercontent.com/4745789/131798196-7946c290-b663-48ac-b7ae-bf9de27bb20c.png" alt="Obsidian HackerNews Plugin" width="400" /> |
| 2 | + |
| 3 | +# Obsidian HackerNews [](https://github.com/arpitbbhayani/obsidian-hackernews/releases)  |
| 4 | + |
| 5 | +The plugin periodically fetches and displays top stories from [HackerNews](https://news.ycombinator.com/) in an [Obsidian](https://obsidian.md) pane. Some of the best stories, blogs, news, and resources are shared on [HackerNews](https://news.ycombinator.com/), and this plugin helps stay updated while using Obsidian. |
| 6 | + |
| 7 | +# Features |
| 8 | + |
| 9 | + - Periodically fetches a random top story from HackerNews. |
| 10 | + - You can save the story as a note allowing you to revisit it again. |
| 11 | + |
| 12 | +# Installation |
| 13 | + |
| 14 | +## Through Community Plugins |
| 15 | + |
| 16 | +> The plugin is [submitted](https://github.com/obsidianmd/obsidian-releases/pull/464) to be published as the official Community Plugin. Once the Obsidian team approves it, you can install the plugin through the following steps. |
| 17 | +
|
| 18 | + - Open the *Command Palette* (default: `ctrl` + `p`), |
| 19 | + - Search for *Open HackerNews* and run the command. |
| 20 | + - You will see that a new View appears in the right Sidebar of Obsidian. |
| 21 | + - Drag and drop like any other pane and power-up your Obsidian. |
| 22 | + |
| 23 | + |
| 24 | +## Manual Install |
| 25 | + |
| 26 | +You can also install this plugin manually through the following steps |
| 27 | + - Create the folder `obsidian-hackernews` under the path `.obsidian/plugins` |
| 28 | + - Download `main.js` and `manifest.json` from the [latest release](https://github.com/arpitbbhayani/obsidian-hackernews/releases) and place them in the folder `.obsidian/plugins/obsidian-hackernews` |
| 29 | + - Reload the Installed plugins under Community Plugins tab, and you would see HackerNews plugin now in the list. |
| 30 | + - Enable this HackerNews plugin and see it in action. |
| 31 | + |
| 32 | +# Is this plugin for you? |
| 33 | + |
| 34 | +This plugin is for you if you use [Obsidian](https://obsidian.md) and |
| 35 | + - are a passionate engineer |
| 36 | + - want to discover amazing articles, resources, and projects |
| 37 | + - want to stay updated with the happenings in the tech world |
| 38 | + |
| 39 | + |
| 40 | +# Why I created this plugin? |
| 41 | +I love reading technical articles and stay updated with the latest happenings in the tech world, and I find [HackerNews](https://news.ycombinator.com/) ideal for this. I have read some of the best articles and found amazing open source libraries through it, and hence I always like to keep a clock eye on HackerNews. |
| 42 | + |
| 43 | +On Mac, I used [YCombinator Plugin](https://github.com/martinsirbe/ycombinator-bitbar) on [BitBar](https://xbarapp.com/), which is very similar and shows one top story from [HackerNews](https://news.ycombinator.com/) in the top menu bar. If the title is enticing enough, I can always learn more about it by clicking the item. This is a great way for me to discover the best resources out there. |
| 44 | + |
| 45 | +Recently, I switched to a Windows machine and found it not having a similar utility; plus, writing a widget for Windows is a mess. When I discovered Obsidian, I found myself using it quite frequently. So I thought of creating a plugin similar to the [YCombinator Plugin](https://github.com/martinsirbe/ycombinator-bitbar) to fetch random top story from HackerNews and show it to me in the side pane. |
| 46 | + |
| 47 | +This is how this Plugin was conceptualized, and now my Obsidian workspace looks like this. |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +# Privacy |
| 52 | +This plugin makes calls to the following APIs to fetch the top stories from HackerNews |
| 53 | + - [https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty](https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty) |
| 54 | + - [https://hacker-news.firebaseio.com/v0/item/8863.json?print=pretty](https://hacker-news.firebaseio.com/v0/item/8863.json?print=pretty) |
| 55 | + |
| 56 | +The API calls are mere GET calls that do not pass any client-side information through the API to `hacker-news.firebaseio.com`. |
| 57 | + |
| 58 | +# About me |
| 59 | + |
| 60 | +Hello, I am [Arpit Bhayani](https://arpitbhayani.me/) - a CS Engineer, Educator, and a Polymath. I love everything around Computer Science, Programming, Mathematics, and Art. You can find me on [Twitter](https://twitter.com/arpit_bhayani), tweeting mostly about nerdy stuff. |
| 61 | + |
| 62 | +In January 2020, I started my [newsletter](https://arpitbhayani.me/newsletter), where I write and share an essay about Distributed Systems, System Design, Programming languages internals, and deep dives on some super-clever algorithms. The newsletter currently has close to **2000+** subscribers. |
| 63 | + |
| 64 | +I have been running a niche [Cohort-based Course](https://arpitbhayani.me/masterclass) on System Design to help engineering become better at designing _scalable_, _fault-tolerant_, and _highly available_ systems. |
| 65 | + |
| 66 | +You can choose to support me in everything I do by sponsoring this plugin. |
| 67 | + |
| 68 | +<a href="https://www.buymeacoffee.com/arpitbhayani"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=arpitbhayani&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00"></a> |
| 69 | + |
0 commit comments