Skip to content
/ notes Public

✍🏻 Simple and minimal notetaking app based on TipTap.

Notifications You must be signed in to change notification settings

USpiri/notes

Repository files navigation

Notes app


Notes App Logo

Simple, extensible and minimal notetaking app based on TipTap.
Explore the docs »

View Demo · Report Bug · Request Feature
CHANGELOG

About Notes

Notes app Screen Shot

Notes aims to be an intuitive, simple and easy-to-use project that can be extended to new needs. It's an evolution from a TipTap implementation to a note management and organization app that I use every day.

Part of the objective, also, is to incorporate new technologies (for me) and that is why new technologies are adopted.

Built With

  • Next
  • Tailwind CSS
  • TipTap
  • Zustand

(back to top)

Features

  • Custom Text editor: Based on TipTap with StarterKit Plugin.
  • Custom components: Callout, MathDisplay, MathInline, etc.
  • Syntax Highlight: for Codeblocks. See more.
  • MathPlugin: KaTeX implementation for math expressions. Inspired on BenRBray Math Plugin. See languages supported.
  • Internal links: Allow the creation of links between notes.
  • LocalStorage Note Management: Allows the creation of notes and nested folders for better organization.
  • Note Only Editor: Shortcuts and commands that allow the use of the editor without the MenuBar (Activate inline editor)

Notes app Screen Shot

Notes app Screen Shot

(back to top)

Roadmap

  • Add CHANGELOG.md
  • Add Image display
  • Drag&Drop for folders, notes and editor components
  • Add Template notes
  • Add Charts
  • Add Tables
  • Improve documentation
  • Add Light mode
  • Make a Tauri App

(back to top)

Contact

Uriel Spiridione - @UrielSpiridione - urielspiridione135@gmail.com

Project Link: https://github.com/USpiri/next-notes/

LinkedIn

(back to top)

Getting Started

Prerequisites

Install dependencies

npm install npm@latest -g

And then, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Learn More

To learn more about Next.js, take a look at the following resources:

(back to top)