NoteHub is a simple and intuitive platform that lets you easily view your Markdown notes stored in GitHub repositories. With a clean and responsive interface, you can browse your notes from anywhere, at any time, and on any device — without the need for complex setups or additional tools.
Whether you're reviewing project documentation, checking personal notes, or simply browsing through your Markdown files, NoteHub makes the experience smooth and accessible.
- 📂 Repository Exploration: Browse and visualize your GitHub repositories with an intuitive graph interface.
- 🖋️ Markdown Rendering: Enjoy full Markdown support, including KaTeX for math formulas and GitHub Flavored Markdown (GFM).
- 🔒 Secure GitHub Integration: Connect to both public and private repositories securely and easily.
- 🎨 Customizable Themes: Adjust the interface to match your style with multiple theme options.
- 🔗 Obsidian Compatibility: Manage and view your Obsidian-styled notes seamlessly.
- Clone the repository:
git clone https://github.com/CuB1z/NoteHub.git
cd NoteHub- Install dependencies:
npm install-
Set up environment variables:
- Create a
.envfile in the root directory and add your variables based on the.env.examplefile. - In order to use the GitHub API, you need to create a personal access token without any scopes (no permissions needed), just to authenticate and avoid hitting the GitHub API rate limit. You can create one here.
- Create a
-
Run the application:
npm run dev- Access the application:
- Open your browser and navigate to
http://localhost:3000. - You should see the NoteHub interface, ready for you to explore your repositories.
- Open your browser and navigate to
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page if you want to contribute.
| Author | GitHub | |
|---|---|---|
| CuB1z | Diego Sánchez | @CuB1z |
NoteHub
Copyright (c) 2025 Diego Sánchez
This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this work. If not, you can view it at https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.