mt 💡

Knowledge management meets spaced repetition.

mt helps organize and manage knowledge efficiently, helping you remember and make sense of information over time.

Features

• Unbeatable UX that just works.
• Markdown-based notes (extensible with plugins) with support for syntax highlighting, Mermaid diagrams, and more.
• Spaced repetition techniques for entire notes
• ... and flashcards (like Anki).
• Notes are stored as markdown files locally on your machine
• Git integration for version control and syncing.
• Cross-linking between notes for building a knowledge graph.
• Full-text search and tagging for easy organization and retrieval.

Getting Started

It is organized around notes, which are just pieces of information in plain text or markdown. These are stored on your machine as plain markdown files.

Notes pop up for review according to a predefined schedule (aka spaced repetition). Reviewing your notes helps you remember them better, gives you a chance to improve them, and update them with new information.

Notes can also include flashcards for active recall practice.

Installation

# npm modules
npm install
npm run install-client
npm run install-server

# start
npm run dev

This will start both the server (port 3000) and client (port 5173). The default directory for notes is ~/mt (or C:\Users\YourName\mt on Windows).

How to use

Markdown

Notes are plain markdown files. Markdown is great - it provides simple means to format text, create lists, tables, links, and more. And at the same time it remains readable in plain text.

Reviewing

Notes you write pop up for review for the first time in 7 days, then in 15 days, in 30, and so on. Press the "Mark as Reviewed" button to review it.

The note will ascend to the next level. There are 10 levels in total. After reaching the last level, the note will not pop up for review anymore.

If you click on the current level in the note toolbar, you can see the whole schedule.

Cross-linking notes and preview

It is crucial for any knowledge management system to build a web of knowledge. Markdown makes it easy with links.

Notes can link to each other using [text](id) syntax, where id is the numeric identifier of the note. You can find the id in the note toolbar. When stored on disk, the note filename starts with its id.

Tags and full-text search

A note can have tags (which are just words prefixed with # in the note body—they can be anywhere in the text). Tags appear in the sidebar; clicking on a tag shows all notes with that tag.

Mermaid

Since markdown is extensible, you can use Mermaid diagrams in your notes (similar to GitHub markdown):

```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;

### Focus mode

By clicking on the focus icon in the note toolbar, you can enter focus mode, which hides all other UI elements, leaving only the note content visible\. This is useful for distraction-free writing\.

### Storage

All your notes are stored in a single folder on your computer\. You'll need to back them up or sync them between devices yourself\. I usually create a git repo and sync it with a private GitHub repository\.

### PWA

mt is a Progressive Web App \(PWA\)\. You can install it on your device like a native app\.

## Contributing

Contributions are welcome\! Please open issues and pull requests, and follow the code of conduct\.