← Back to Home

NoteFlow Documentation

Everything you need to know about using NoteFlow, including our Markdown and Mermaid cheatsheet.

Core Features

NoteFlow is a fully-featured markdown editor designed for speed and simplicity. We automatically save your notes to the cloud and allow you to access them from anywhere.

  • Live Preview: See your markdown rendered instantly as you type.
  • Exporting: Click the 'Export' button in the editor to download your note as a PDF or standalone HTML file.
  • Version History: NoteFlow takes periodic snapshots of your notes. Click the 'History' icon to revert to older versions.
  • Tags & Search: Add #tags anywhere in your text. You can filter and search for tags in the dashboard.

Markdown Cheatsheet

NoteFlow supports GitHub-Flavored Markdown (GFM). Here are some common formatting patterns:

# Heading 1 ## Heading 2 ### Heading 3 **Bold text** and *Italic text* ~~Strikethrough~~ > Blockquote - Unordered list item 1 - Unordered list item 2 1. Ordered list item 1 2. Ordered list item 2 [Link Text](https://example.com) ![Image Alt Text](https://example.com/image.png) `Inline code` ```javascript // Code block with syntax highlighting function hello() { console.log("Hello NoteFlow!"); } ``` | Table Header | Table Header | | ------------ | ------------ | | Cell 1 | Cell 2 |

Mermaid Diagrams

You can easily generate charts and diagrams natively using Mermaid syntax. Just create a code block with the language set to mermaid.

Flowchart Example

```mermaid graph TD; A[Start] --> B{Is it raining?}; B -- Yes --> C[Take umbrella]; B -- No --> D[Enjoy the sun]; C --> E[Go outside]; D --> E; ```

Sequence Diagram Example

```mermaid sequenceDiagram Alice->>+John: Hello John, how are you? John-->>-Alice: Great! ```

For more advanced diagrams, please refer to the official Mermaid documentation.