ParasKoundal/GitNotes

An extension that allows you to take notes (with local only storage) specifically for the GitHub repository you are currently viewing.

โ˜… 1Forks 0JavaScriptGitHub โ†—Compare

README

GitNotes Extension

Context-aware notes for your GitHub repositories.

GitNotes is a Chrome Extension that allows you to take notes specifically for the GitHub repository you are currently viewing. It opens as a side panel, giving you a seamless note-taking experience right next to your code.

Features

  • Context-Aware: Automatically detects the GitHub repo you are on (e.g., facebook/react) and filters your notes to show only those relevant to that repo.
  • Side Panel: Opens in the Chrome Side Panel for a non-intrusive workflow.
  • Rich Text & Markdown: Supports code blocks, links, and basic formatting.
  • Local Storage: All data is stored locally on your machine for privacy and speed.
  • Version History: Keep track of changes with a built-in history and diff viewer.
  • Dark Mode: Automatically respects your system's theme preferences.

Installation

Since GitNotes is currently in development, you can install it manually:

  1. Download/Clone this repository to your local machine.
  2. Open Google Chrome and navigate to chrome://extensions.
  3. Enable Developer mode by toggling the switch in the top right corner.
  4. Click the Load unpacked button.
  5. Select the GitNotes folder from the downloaded files.
  6. The extension is now installed! Pin it to your toolbar for easy access.

Usage

  1. Navigate to any GitHub repository.
  2. Click the GitNotes icon in your toolbar (or open the Side Panel).
  3. Start typing! Your notes are automatically linked to the current repository.
  4. Double-click a note or click its repo badge to open the repository in a new tab.

Coming Soon

๐Ÿš€ GitNotes will hopefully be available on the Chrome Web Store soon! Stay tuned for an easier installation process.

Support

If you find this extension useful, consider buying me a coffee! Buy Me A Coffee

Contributors

ParasKoundal

Issues