Noteriv Docs

Noteriv is a free, open-source markdown note-taking app for desktop (Linux, Windows, macOS) and mobile. Your notes live as plain .md files inside a vault — a regular folder on your filesystem.

Create a Vault

When you launch Noteriv for the first time, you will see the vault picker. Click Create new vault, choose a name and a location on disk, then hit Create. Noteriv creates the folder and a small .noteriv/ directory inside it for app-level settings (themes, plugins, layout state). You can open any existing folder as a vault too — Noteriv will never modify files it does not own.

my-vault/
  .noteriv/          # app settings, plugin data, themes
  daily/             # daily notes (configurable)
  projects/          # your folders
  welcome.md         # your first note

Write Your First Note

Press Ctrl+N (or click the + button in the sidebar) to create a new note. Give it a title, then start typing markdown. The editor renders formatting inline as you type — move your cursor away from a line and bold, italic, headings, links, and code all render in-place.

Noteriv supports full CommonMark plus many extensions. Below is a comprehensive reference of every syntax element the editor understands.

Inline Formatting

**bold text**
*italic text*
~~strikethrough~~
==highlighted text==
`inline code`
$inline math: E = mc^2$
^superscript^
~subscript~

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Second item
   1. Nested ordered

- [ ] Unchecked task
- [x] Completed task

Links & Wiki-Links

[Link text](https://example.com)
[Link with title](https://example.com "Title")

[[note name]]              # wiki-link
[[note name|display text]] # aliased wiki-link

Wiki-links are the backbone of Noteriv’s knowledge graph. Type [[ and an autocomplete dropdown suggests notes from your vault. Renaming a note updates all references.

Images & Embeds

![Alt text](image.png)
![Alt text|600x400](image.png)   # with dimensions

![[file.md]]       # embed another note inline
![[image.png]]     # embed an image from vault
![[file.pdf]]      # embed a PDF

Tables

| Column A | Column B | Column C |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Blockquotes & Callouts

> Standard blockquote
> Can span multiple lines

Callouts use a special blockquote syntax with a type identifier. Noteriv supports 14 callout types:

> [!note] Title
> Callout body content

> [!tip] Helpful hint
> Use callouts to highlight important information.

> [!warning] Be careful
> This action cannot be undone.

Code Blocks

Fenced code blocks are syntax-highlighted. Noteriv supports all major languages:

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

Table of Contents

Add [TOC] anywhere in a note and Noteriv renders a live table of contents generated from the headings in the document.

[TOC]

# Section One
## Subsection
# Section Two

Mermaid Diagrams

Use ```mermaid code blocks to create flowcharts, sequence diagrams, Gantt charts, pie charts, and more — rendered live as you type.

```mermaid
graph LR
    A[Write Note] --> B[Link Notes]
    B --> C[Build Knowledge]
```

Math (KaTeX)

Inline: $E = mc^2$

Block:
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

Dataview Queries

Write queries in ```dataview blocks to turn your vault into a queryable database. Supports TABLE, LIST, and TASK query types with FROM, WHERE, SORT, and LIMIT clauses.

```dataview
TABLE status, due FROM "projects"
WHERE status != "done"
SORT due ASC
LIMIT 10
```

```dataview
LIST FROM #reading
WHERE rating > 4
SORT rating DESC
```

```dataview
TASK FROM "daily"
WHERE !completed
SORT due ASC
```

Flashcards

Write flashcards directly inside your notes using two syntaxes. Noteriv schedules reviews with the SM-2 spaced repetition algorithm.

Q: What is the capital of France?
A: Paris

Q: What does HTTP stand for?
A: HyperText Transfer Protocol

The mitochondria is the {{powerhouse}} of the cell.
Photosynthesis converts {{light energy}} into {{chemical energy}}.

Definition Lists

Term
: Definition of the term

Another term
: First definition
: Second definition

Footnotes

This claim needs a source[^1].

Another referenced point[^note].

[^1]: Source citation here.
[^note]: A longer footnote with multiple paragraphs.

Noteriv ships with a complete set of tools for writing, organizing, and connecting your ideas. For a detailed breakdown of every feature, visit the Features page.

Noteriv is designed for keyboard-driven workflows. All shortcuts are customizable in Settings.

Noteriv ships an MCP (Model Context Protocol) server with 22 tools, published as noteriv-mcp on npm. Connect it to Claude Code, Cursor, or any MCP-compatible AI assistant and let them read, search, create, and modify notes in your vault programmatically.

Setup

npx noteriv-mcp

Add the server to your MCP client configuration. For Claude Code, add it to your .claude.json or MCP settings:

{
  "mcpServers": {
    "noteriv": {
      "command": "npx",
      "args": ["noteriv-mcp"]
    }
  }
}

22 Tools in 6 Categories

Noteriv supports three sync methods. Every option keeps your notes on infrastructure you control — no proprietary cloud service sits between you and your files.

Git Sync

The most powerful option. Noteriv’s built-in Git integration handles stash/pop for unsaved changes, commits, pulls, and pushes — all from within the app. Point your vault at a Git remote and sync automatically on save or on a configurable interval.

# Initialize your vault as a git repo
cd ~/my-vault
git init
git remote add origin git@github.com:you/my-vault.git

# Noteriv handles the rest — commit, pull, push from the app

Folder Sync

Mirror your vault to a second directory on disk. Useful for syncing to a cloud drive folder (Dropbox, Google Drive, OneDrive) or an external backup location. Noteriv watches for changes in both directions.

Settings > Sync > Folder Sync
  Source: ~/my-vault
  Target: ~/Dropbox/noteriv-backup
  Interval: On save

WebDAV Sync

Connect to a WebDAV server (Nextcloud, ownCloud, or any standard WebDAV endpoint) to sync your vault over the network. Enter your server URL, username, and password in Settings, and Noteriv handles uploads, downloads, and conflict detection.

Settings > Sync > WebDAV
  URL: https://cloud.example.com/remote.php/dav/files/you/vault
  Username: you
  Password: ••••••••
  Interval: Every 5 minutes

Extend Noteriv with community-built plugins. The plugin system provides a rich API for adding new features without forking the core codebase.

Installing Plugins

Open Settings > Plugins > Browse to see the community plugin registry. Click Install on any plugin, and it downloads into your vault’s .noteriv/plugins/ directory. Plugins are sandboxed and can be enabled or disabled individually.

Enabling & Disabling

Toggle plugins on and off from Settings > Plugins > Installed. Disabled plugins remain on disk but do not load at startup. You can also set per-vault plugin configurations if a plugin exposes settings.

Plugin API

The plugin API exposes lifecycle hooks and access to core systems:

import { Plugin } from "noteriv";

export default class MyPlugin extends Plugin {
  onLoad() {
    // Called when the plugin is enabled
    this.registerCommand({
      id: "my-command",
      name: "My Custom Command",
      hotkey: "Ctrl+Shift+M",
      callback: () => {
        // Your logic here
      },
    });

    this.registerStatusBarItem({
      text: "My Plugin",
      onClick: () => console.log("clicked"),
    });
  }

  onUnload() {
    // Cleanup when disabled
  }

  onFileOpen(file: NoteFile) {
    // React to file open events
  }

  onFileSave(file: NoteFile) {
    // React to file save events
  }
}

Available hooks: onLoad, onUnload, onFileOpen, onFileSave. Plugins can register commands in the command palette, add status bar widgets, and read/write editor state.