An open API service indexing awesome lists of open source software.

https://github.com/scabir/notebranch

An open source desktop Markdown workspace with Git, AWS S3, and local first for notes; built with Electron, React, and TypeScript.
https://github.com/scabir/notebranch

aws-s3 cross-platform desktop-app electron git knowledge-base knowledge-management linux-desktop mac-desktop markdown markdown-editor mermaid note-taking notes-app productivity react typescript vite wiki windows-desktop

Last synced: 3 months ago
JSON representation

An open source desktop Markdown workspace with Git, AWS S3, and local first for notes; built with Electron, React, and TypeScript.

Awesome Lists containing this project

README

          

# NoteBranch

Your Markdown workspace for real projects, docs, and personal knowledge bases, backed by Git, AWS S3, or Local storage.

[![Coverage](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scabir/NoteBranch/main/badges/coverage.json)](https://github.com/scabir/notebranch/actions/workflows/coverage.yml)
[![Integration](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scabir/NoteBranch/main/badges/integration.json)](https://github.com/scabir/notebranch/actions/workflows/integration.yml)
[![macOS](https://img.shields.io/github/actions/workflow/status/scabir/NoteBranch/macos-dmg.yml?branch=main&label=macOS)](https://github.com/scabir/notebranch/actions/workflows/macos-dmg.yml)
[![Windows](https://img.shields.io/github/actions/workflow/status/scabir/NoteBranch/windows-installer.yml?branch=main&label=Windows)](https://github.com/scabir/notebranch/actions/workflows/windows-installer.yml)
[![Linux](https://img.shields.io/github/actions/workflow/status/scabir/NoteBranch/linux-packages.yml?branch=main&label=Linux)](https://github.com/scabir/notebranch/actions/workflows/linux-packages.yml)

Official website: [notebranch.app](https://notebranch.app)

**Version**: 2.9.1
**License**: MIT

## Built for daily note workflows

NoteBranch keeps your notes where your work already lives. Write in Markdown, connect to your repository type of choice, and keep everything organized and versioned in one desktop app.

## See it in action

### Write and preview side by side

![Write and preview Markdown in split view](tutorials/scenarios/create-and-edit-markdown-preview-split/images/step-05-split-view.png)

### Organize notes quickly

![Organize files with rename, move, duplicate, and favorites](tutorials/scenarios/organize-files-rename-move-duplicate-favorite/images/step-06-add-favorite.png)

### Work in your language

![Switch app language to Spanish from settings](tutorials/scenarios/switch-language-and-verify-persistence/images/step-03-save-new-language.png)

Supported languages:

- English
- Chinese (中文)
- Hindi (हिन्दी)
- Spanish (Español)
- German (Deutsch)
- Arabic (العربية)
- French (Français)
- Russian (Русский)
- Portuguese (Português)
- Japanese (日本語)
- Turkish (Türkçe)
- Italian (Italiano)
- Polish (Polski)
- Ukrainian (Українська)
- Kurdish (Kurdî)
- Swedish (Svenska)
- Greek (Ελληνικά)

### Use NoteBranch in dark mode

![Use NoteBranch in dark mode](tutorials/scenarios/switch-language-and-verify-persistence/images/step-04-dark-mode-workspace.png)

## What you can do

- Connect Git, AWS S3, or Local repositories
- Create Markdown notes with editor, preview, and split view
- Organize files and folders with rename, move, duplicate, and favorites
- Search and replace in current file and across the repository
- Review file history and versions
- Export the current note or the full repository as ZIP

## Installation

All releases: [github.com/scabir/notebranch/releases](https://github.com/scabir/notebranch/releases)

## Website

Live website: [notebranch.app](https://notebranch.app)
Static product website source:
[app/website/README.md](app/website/README.md)

## User Guide

New to NoteBranch? Start here with a complete walkthrough:
[Read the User Guide with setup steps, daily workflows, and troubleshooting](docs/USER_GUIDE.md)

## Tutorials

- [Connect Git Repository](tutorials/scenarios/connect-git-repository/README.md)
- [Create and Edit Markdown (Preview + Split)](tutorials/scenarios/create-and-edit-markdown-preview-split/README.md)
- [Organize Files: Rename, Move, Duplicate, Favorite](tutorials/scenarios/organize-files-rename-move-duplicate-favorite/README.md)
- [Search and Replace (File + Repository)](tutorials/scenarios/search-and-replace-file-and-repo/README.md)
- [Commit, Pull, Push from Status Bar](tutorials/scenarios/commit-pull-push-from-status-bar/README.md)
- [View History and Restore Reference](tutorials/scenarios/view-history-and-restore-reference/README.md)
- [Export Note and Repository ZIP](tutorials/scenarios/export-note-and-export-repository-zip/README.md)
- [Connect AWS S3 Bucket with Prefix](tutorials/scenarios/connect-s3-bucket-with-prefix/README.md)
- [Edit and Auto-Sync Pending Changes](tutorials/scenarios/edit-and-auto-sync-pending-to-synced/README.md)
- [AWS S3 History with Versioned Objects](tutorials/scenarios/s3-history-with-versioned-objects/README.md)
- [Create Local Repository and Work Offline](tutorials/scenarios/create-local-repository-and-work-offline/README.md)
- [Local Save and Reopen Persistence Check](tutorials/scenarios/local-save-and-reopen-persistence-check/README.md)
- [Switch Language and Verify Persistence](tutorials/scenarios/switch-language-and-verify-persistence/README.md)

Tutorial hub: [tutorials/README.md](tutorials/README.md)

## Technical Documentation

- [Technical Documentation](docs/tech/README.md)

## Support

Open an issue: https://github.com/scabir/notebranch/issues

## Outro

Thanks for using NoteBranch.

Built and maintained by **Suleyman Cabir Ataman**.