NoteHub

Browse, search, and read your NoteHub notes directly inside VS Code. Organize collections, open rich-text notes, and stay focused without leaving your editor.

GitHub stars GitHub forks VS Code Marketplace Installs

Table of Contents

About
Getting Started
Features
How It Works
Settings
Development
Contributing
Roadmap
Follow Me
Give A Star
License

📖 About

NoteHub brings your notes directly into Visual Studio Code.

Browse collections, instantly search across notes, and read beautifully rendered notes without switching to your browser.

The extension supports rich text, syntax-highlighted code blocks, mathematical expressions with KaTeX, private/public notes, and opens every note in a dedicated VS Code webview.

Whether you're documenting projects, storing snippets, or writing technical notes, everything stays one shortcut away.

🚀 Getting Started

Install the extension.
Open the NoteHub Activity Bar icon.
Sign in using your NoteHub account.
Your collections automatically appear.
Click any note to open it.
Press Ctrl+Alt+K to search all public notes instantly.

Your login session is securely stored using VS Code's encrypted Secret Storage.

✨ Features

📁 Browse collections directly from the Activity Bar
📄 Open notes inside a beautiful rich-text viewer
🔍 Instant note search with keyboard shortcut
🌍 Search public notes without signing in
🔒 Private notes with automatic authentication
💻 Syntax highlighting powered by Highlight.js
➗ Mathematical equations rendered using KaTeX
📋 Copy individual code blocks
📑 Copy the entire note as Markdown
🌐 Open notes in your browser
🔄 One-click refresh
⚡ Fast loading with optimistic updates
🎨 Native VS Code theme support

⚙️ How It Works

The extension communicates directly with the NoteHub API.

Collections are loaded from

GET /api/collection/all-collections

Notes are loaded from

GET /api/note/:username/:collection/:note

Search uses

GET /api/note/search

Authentication uses the same JWT flow as the NoteHub website.

Access tokens are refreshed automatically when needed and stored securely using VS Code Secret Storage.

⚙️ Settings

Open

Settings → Extensions → NoteHub

Setting	Description	Default
`notehub.apiBaseUrl`	Base URL of the NoteHub API	`https://notehub-38kp.onrender.com/api`
`notehub.siteBaseUrl`	Base URL of the NoteHub website	`https://notehub-official.vercel.app`

Development

npm install
npm run compile

Press F5 to launch an Extension Development Host.

Method	Description	Command
🔧 Compile	Compile TypeScript	`npm run compile`
📦 Package	Generate VSIX	`vsce package`

npm install -g @vscode/vsce
npm run compile
vsce package

🤝 Contributing

Contributions are always welcome.

Fork the repository
Create a branch

git checkout -b feature-name

Commit your changes

git commit -m "Add feature"

Push your branch

git push origin feature-name

Open a Pull Request

Please create an issue first if you'd like to discuss a major feature.

🗺️ Roadmap

⭐ Favorite notes
📌 Pin collections
📝 Create notes directly inside VS Code
✏️ Edit notes
📂 Offline cache
🔔 Notifications for shared notes
🔄 Live synchronization

📡 Follow Me

⭐ Give A Star

If this extension saves you time, consider giving the repository a ⭐ on GitHub. It helps more developers discover the project.

📄 License

MIT License — see LICENSE.

NoteHub Official

MRCodium