Noteriv

https://noteriv.com/docs
Admin
Noteriv is a free, open-source markdown note-taking app for desktop (Linux, Windows, macOS) and...
Tokens:2,497
Snippets:40
Trust Score:2.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install MCP Server

Source: https://noteriv.com/docs

Run the Noteriv MCP server via npx.

```bash
npx noteriv-mcp
```

--------------------------------

### Create Lists

Source: https://noteriv.com/docs

Syntax for unordered, ordered, and task lists.

```markdown
- Unordered item
- Another item
  - Nested item

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

- [ ] Unchecked task
- [x] Completed task
```

--------------------------------

### Create Tables

Source: https://noteriv.com/docs

Standard markdown table syntax.

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

--------------------------------

### Create Definition Lists

Source: https://noteriv.com/docs

Standard markdown definition list syntax.

```markdown
Term
: Definition of the term

Another term
: First definition
: Second definition
```

--------------------------------

### Configure MCP Client

Source: https://noteriv.com/docs

Add the Noteriv MCP server to your client configuration file.

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

--------------------------------

### Initialize Git Repository for Vault

Source: https://noteriv.com/docs

Commands to initialize a local directory as a Git repository and link it to a remote origin.

```bash
cd ~/my-vault
git init
git remote add origin git@github.com:you/my-vault.git
```

--------------------------------

### Use Callouts

Source: https://noteriv.com/docs

Special blockquote syntax for highlighting information with specific types.

```markdown
> [!note] Title
> Callout body content

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

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

--------------------------------

### Configure Folder Sync

Source: https://noteriv.com/docs

Settings for mirroring a vault directory to a local backup or cloud-synced folder.

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

--------------------------------

### Create Headings

Source: https://noteriv.com/docs

Markdown heading levels from 1 to 6.

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

--------------------------------

### Configure WebDAV Sync

Source: https://noteriv.com/docs

Settings for connecting to a remote WebDAV server for network-based vault synchronization.

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

--------------------------------

### Create Blockquotes

Source: https://noteriv.com/docs

Standard markdown blockquote syntax.

```markdown
> Standard blockquote
> Can span multiple lines
```

--------------------------------

### Insert Links

Source: https://noteriv.com/docs

Standard markdown links and Noteriv-specific wiki-links for knowledge graph linking.

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

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

--------------------------------

### Define Flashcards

Source: https://noteriv.com/docs

Create flashcards using Q/A format or cloze deletion syntax for spaced repetition.

```markdown
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}}.
```

--------------------------------

### Implement a Noteriv Plugin

Source: https://noteriv.com/docs

Boilerplate structure for creating a plugin using the Noteriv TypeScript API, including lifecycle hooks and UI registration.

```typescript
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
  }
}
```

--------------------------------

### Plugin Lifecycle and Registration

Source: https://noteriv.com/docs

The base Plugin class provides lifecycle hooks and methods to register commands and UI components.

```APIDOC
## Plugin API

### Description
Extend Noteriv by extending the `Plugin` class. Plugins can react to application events and register custom functionality.

### Lifecycle Hooks
- **onLoad()**: Called when the plugin is enabled.
- **onUnload()**: Called when the plugin is disabled for cleanup.
- **onFileOpen(file: NoteFile)**: Triggered when a note file is opened.
- **onFileSave(file: NoteFile)**: Triggered when a note file is saved.

### Registration Methods
- **registerCommand(options)**: Adds a command to the command palette.
  - **id** (string): Unique identifier for the command.
  - **name** (string): Display name of the command.
  - **hotkey** (string): Keyboard shortcut.
  - **callback** (function): Logic to execute.
- **registerStatusBarItem(options)**: Adds a widget to the status bar.
  - **text** (string): Display text.
  - **onClick** (function): Click handler.
```

--------------------------------

### Render Math Expressions

Source: https://noteriv.com/docs

Supports LaTeX math syntax for both inline and block-level equations.

```markdown
Inline: $E = mc^2$

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

--------------------------------

### Embed Images and Files

Source: https://noteriv.com/docs

Syntax for embedding images, PDFs, and other notes within a document.

```markdown
![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
```

--------------------------------

### Create Mermaid Diagrams

Source: https://noteriv.com/docs

Use Mermaid syntax within code blocks to render flowcharts and other diagrams.

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

--------------------------------

### Format Inline Markdown

Source: https://noteriv.com/docs

Syntax for common inline text styling, including math and sub/superscript.

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

--------------------------------

### Query Vault Data with Dataview

Source: https://noteriv.com/docs

Use Dataview queries to generate tables, lists, and task lists from vault metadata.

```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
```

--------------------------------

### Add Fenced Code Blocks

Source: https://noteriv.com/docs

Syntax for adding syntax-highlighted code blocks.

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

--------------------------------

### Add Footnotes

Source: https://noteriv.com/docs

Reference citations or additional notes using footnote syntax.

```markdown
This claim needs a source[^1].

Another referenced point[^note].

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

--------------------------------

### Generate Table of Contents

Source: https://noteriv.com/docs

Insert a dynamic table of contents based on document headings.

```markdown
[TOC]
```

--------------------------------

### Define Vault Structure

Source: https://noteriv.com/docs

The directory layout for a Noteriv vault, including the hidden .noteriv configuration folder.

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