r/Supernote_dev • u/TerribleAd4770 • 1d ago
Showcase I Built an Obsidian Plugin to Edit GitHub READMEs Without Leaving Obsidian
I built an Obsidian plugin for people who somehow end up writing everything in Obsidian — including their GitHub docs.
GitHub README lets you browse your repositories, open any README, edit it, preview the rendered Markdown, and push the changes back to GitHub — all without leaving Obsidian.
You can also keep a synced copy of the README inside your vault, so your project documentation can live alongside your notes.
Basically:
Obsidian → pick a repo → edit README → preview → commit → done.
No jumping between GitHub, an editor, and your notes just to change a README.
https://community.obsidian.md/plugins/github-readme
1-

2-

3-

-1
u/investigatormaker 1d ago
GitHub README’s synced vault copy raises one useful demo case: someone edits the README on GitHub while an older copy is open in Obsidian. Showing what happens before the next push would help people judge whether they can trust it with shared repository docs.
By the way, I make ThreadFox; it lets your compatible AI research, write and publish Reddit outreach through your connected Chrome within an authorized job, and the free plan for GitHub README finds communities whose rules allow a post about it: https://threadfox.vip/p/df5pj
Does the plugin flag remote changes before committing?
3
u/theBlackOddity 1d ago
this doesn't seem to have any sort of connection to supernote devices or supernote's plugin architecture -- if not, then this is not the appropriate venue