Formatting guide

Markdown, diagrams, and math

Every Notedog entry is a plain Markdown file. The live preview — in the app on your phone and in the paired browser editor — renders GitHub-flavored Markdown, mermaid diagrams, and LaTeX math. Here is what you can write, with live examples.

The examples below are rendered right here on this page by the same engines Notedog uses (KaTeX for math, Mermaid for diagrams), so what you see is what you get in the app.

Markdown

Notedog speaks GitHub-flavored Markdown (GFM). The everyday building blocks:

Headings, emphasis, and links

You write

# Morning pages

Some **bold**, some _italic_, and a
[link](https://notedog.run).

You see

Morning pages

Some bold, some italic, and a link.

Lists and task lists

You write

- Groceries
- Ideas
  - Sub-idea

1. First
2. Second

- [x] Shipped
- [ ] Still to do

You see

Groceries
Ideas
- Sub-idea

First
Second

Shipped
Still to do

Quotes and code

You write

> A quote worth keeping.

Inline `code`, and a block:

```js
const greet = () => "hello";
```

You see

A quote worth keeping.

Inline code, and a block:

const greet = () => "hello";

Fenced code blocks are syntax-highlighted in the Notedog preview.

Tables

You write

| Day | Mood |
| --- | ---- |
| Mon | calm |
| Tue | tired |

You see

Day	Mood
Mon	calm
Tue	tired

Mermaid diagrams

Fence a code block as mermaid and Notedog renders it as a diagram — handy for flows, sequences, and quick sketches. Full Mermaid syntax.

Flowchart

You write

```mermaid
flowchart LR
  A[Write on phone] --> B[Edit in browser]
  B --> C[Back up with Git]
```

You see

flowchart LR
  A[Write on phone] --> B[Edit in browser]
  B --> C[Back up with Git]

Sequence

You write

```mermaid
sequenceDiagram
  Browser->>Phone: open journal
  Phone-->>Browser: entries
```

You see

sequenceDiagram
  Browser->>Phone: open journal
  Phone-->>Browser: entries

LaTeX math

Write LaTeX between math delimiters. Inline with $ … $ or $ … $; a centered block with $$ … $$ or \[ … \]. Notedog accepts both styles.

Inline

You write

Euler's identity, $e^{i\pi} + 1 = 0$,
in the middle of a sentence.

You see

Euler's identity, $e^{i\pi} + 1 = 0$, in the middle of a sentence.

Display

You write

$$
\int_0^\infty e^{-x^2}\,dx = \frac{\sqrt{\pi}}{2}
$$

You see

$$\int_0^\infty e^{-x^2}\,dx = \frac{\sqrt{\pi}}{2}$$

All of this renders live as you type — in the in-app preview and the paired browser editor — and your entry stays a plain .md file the whole time.

← Back to features