Skip to content

Repository files navigation

NoteForge

NoteForge Main Interface

A modern Markdown note-taking application built with Electron, React and Tailwind CSS.

Version License Platform


Overview

NoteForge is a desktop Markdown editor focused on speed, organization and customization. It combines a clean writing experience with powerful editing capabilities, notebook management and an interface designed for daily use.


Preview

Main Workspace

Workspace

Settings

Settings

Mathematical Expressions

KaTeX support allows rendering mathematical notation directly inside your notes.

Math


Features

Markdown Editor

  • Live preview with synchronized scrolling
  • Multiple editor layouts
  • Syntax highlighting
  • Line numbers
  • Active line highlighting
  • Adjustable typography
  • Word wrap options
  • Configurable editor width

Organization

  • Notebook management
  • Colored tags
  • Instant search
  • Favorites
  • Advanced filtering

Markdown Support

Supports both CommonMark and GitHub Flavored Markdown.

Available extensions include:

  • Tables
  • Task Lists
  • Footnotes
  • KaTeX / LaTeX
  • Mermaid diagrams
  • Embedded HTML

Customization

Configure nearly every aspect of the editor.

Editor

  • Fonts
  • Font size
  • Line height
  • Maximum text width
  • View modes
  • Auto-save
  • Session restoration

Interface

  • Light theme
  • Dark theme
  • System theme
  • Blur effects (Windows)
  • Adjustable border radius
  • Interface density
  • Animation controls

Keyboard Shortcuts

  • Fully customizable shortcuts
  • Default profile
  • Import / Export configurations

Additional Features

  • Automatic welcome note
  • Session persistence
  • Local Markdown storage
  • Fast file indexing
  • Cross-platform support

Installation

Requirements

  • Node.js 18+
  • Yarn

Clone the repository:

git clone https://github.com/Angel87develop/NoteForge.git
cd NoteForge

Install dependencies:

yarn install

Run the development version:

yarn dev

Building

Build for your operating system.

yarn build:win
yarn build:mac
yarn build:linux

Unpacked build:

yarn build:unpack

Project Structure

NoteForge
├── src
│   ├── main
│   ├── preload
│   └── renderer
│       ├── components
│       ├── contexts
│       ├── types
│       └── utils
│
├── resources
├── build
└── out

Tech Stack

Technology Purpose
Electron Desktop application
React User Interface
TypeScript Static typing
Tailwind CSS Styling
React Markdown Markdown rendering
Remark GFM GitHub Flavored Markdown
Electron Vite Development tooling
Electron Builder Application packaging

Local Storage

Notes are stored locally inside the user's Documents folder.

Windows
%USERPROFILE%/Documents/noteforge-notes
macOS
~/Documents/noteforge-notes
Linux
~/Documents/noteforge-notes

Each note is saved as an individual Markdown file.

Title_NoteID.md

Available Scripts

yarn dev

Runs the application in development mode.

yarn build

Builds the application.

yarn typecheck

Runs TypeScript checks.

yarn lint

Runs ESLint.

yarn format

Formats the project using Prettier.


Contributing

Contributions are welcome.

  1. Fork the repository.
  2. Create a feature branch.
git checkout -b feature/my-feature
  1. Commit your changes.
git commit -m "Add new feature"
  1. Push the branch.
git push origin feature/my-feature
  1. Open a Pull Request.

License

This project is licensed under the MIT License.

See the LICENSE file for more information.


Credits

  • electron-vite
  • React Markdown
  • Tailwind CSS
  • Electron

Support

Bug reports, feature requests and questions can be submitted through the GitHub Issues page.

https://github.com/Angel87develop/NoteForge/issues

About

This is a personal project designed to be a Markdown-based note-taking application. The technologies used were: Electron, React, Tailwind CSS, and Yarn.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages