Documentation

Create & Edit Markdown (.md) Files Online

Draft READMEs, technical documentation, meeting notes, and blog posts in Markdown with live split-screen preview, formatting shortcuts, and instant .md export.

16px
1
0 words 0 chars 0 no spaces 1 lines 0 paragraphs
Ln 1, Col 1 Saved locally
Authoritative Guide & Syntax Reference

In-Depth Guide: Create & Edit Markdown (.md) Files Online

Everything you need to know about formatting rules, technical specifications, best practices, and real-world workflows.

1. What is Markdown? The Universal Standard for Technical Documentation

Markdown is a lightweight plain-text markup language created in 2004 by John Gruber and Aaron Swartz. Designed with the core philosophy that plain-text formatting should be instantly readable and publishable without proprietary word processors, Markdown has become the global standard for software documentation (README.md), GitHub issue tracking, static site generators (Astro, Next.js, Hugo, Docusaurus), and modern personal knowledge management tools (Obsidian, Notion, Logseq).

2. Comprehensive Markdown & CommonMark Syntax Reference

Outsmart Notes supports standard CommonMark and GitHub Flavored Markdown (GFM) formatting:

  • Headings: Prefix lines with # for H1, ## for H2, down to ###### for H6.
  • Typography Emphasis: Wrap text in **bold** for strong emphasis, *italic* for italics, and ~~strikethrough~~ for struck-through text.
  • Interactive Task Lists: Write - [ ] Pending task for unchecked boxes and - [x] Completed task for checked boxes.
  • Fenced Code Blocks: Wrap code in triple backticks with optional language specifiers (e.g. ```javascript ... ```).
  • Hyperlinks & Images: Use [Link Label](https://example.com) for clickable links and ![Alt Text](image.png) for embedded graphics.
  • Blockquotes: Begin lines with > for styled callouts and inspirational quotations.
  • Horizontal Dividers: Place three hyphens --- on an empty line to insert a section dividing rule.

3. GitHub Flavored Markdown (GFM) Tables, Task Checklists & Code Blocks

Outsmart Notes fully supports advanced GitHub Flavored Markdown extensions:

| Feature Name | Status | Priority |\n| :--- | :---: | ---: |\n| AES-GCM Vault | Active | High |\n| PDF Document Export | Released | Critical |\n| Slash Commands (/) | Active | High |

In Markdown Preview mode, tables render with responsive borders, alternating row colors, and custom column text alignments (left :---, center :---:, right ---:).

4. Personal Knowledge Management: Wiki Links ([[Note]]) & Slash Commands (/)

Outsmart Notes integrates modern PKM capabilities directly into the writing workflow:

  • Bi-Directional Wiki Links: Type [[Note Title]] anywhere in your document to link notes together. In Markdown Preview, these become clickable links with an automatic Backlinks reference panel.
  • Notion-Style Slash Commands: Press / on any blank line to open a floating quick-insert menu for headings, checklists, code blocks, divider lines, and timestamps.
  • Real-Time Task Percentage: The status bar calculates task completion progress automatically (e.g. 3/5 tasks (60%)).

5. Live Split-Screen Preview, Zen Mode and Multi-Format Export

Toggle Preview (Ctrl + Shift + M) to view your formatted Markdown rendered side-by-side with live auto-refresh. When ready to distribute, export directly to .md, high-resolution printable PDF with vector checkboxes, Microsoft Word .docx, or HTML.

High-Performance Platform

Engineered for Documentation

Engineered for speed, privacy, and productivity. Zero virtual-DOM overhead, native IndexedDB persistence, Web Worker offloading, zero-knowledge encryption, and powerful Pro PKM tools.

Sub-Second Cold Boot

Built with high-performance vanilla JS without bloated single-page framework overhead. Loads instantly and is ready to type in under 1 second with 60 FPS responsiveness.

Notion-Style Slash Commands

Type / on any new line to trigger an interactive quick-insert menu. Effortlessly insert headings, task checklists, bullet & numbered lists, code blocks, tables, and callouts.

Voice Typing & Speech-to-Text

Dictate long-form notes, brainstorms, and thoughts hands-free using real-time speech recognition. Includes live audio recording visualization and instant text transcription.

PDF, Word & Document Importer

Upload and extract text client-side from PDF files (via PDF.js), Word documents (.docx), Markdown, TXT, JSON, CSV, YAML, and code files with zero server uploads.

Interactive Checklists & Tasks

Build dynamic to-do lists with markdown - [ ] syntax. Click checkboxes to toggle tasks in both editor and live preview, with live task completion stats in the status bar.

Zen Focus & Typewriter Scroll

Immerse yourself in distraction-free writing (F10). Enables centered typewriter scrolling that keeps your active typing line locked in the center of your screen.

Spotlight Quick Switcher (Ctrl+K)

Jump between notes, search text across your workspace, execute formatting commands, and filter tags instantly from a keyboard-first command palette.

Version History & Snapshots

Never lose important work. Automatic snapshot checkpoints saved locally in IndexedDB allow you to view historical revisions, inspect diffs, and roll back with a single click (Ctrl+H).

Hashtag Organization & Filters

Tag notes with #tags anywhere in your text. Click tag pills in notes or use the drawer filter to instantly group related research, projects, and ideas.

PRO

Password-Locked Vault

Secure confidential thoughts, credentials, and diaries with military-grade client-side 256-bit AES-GCM vault encryption. Unlocks seamlessly with your master key.

PRO

Wiki Links & Backlinks

Connect your thoughts with bi-directional wiki links ([[Note Title]]), floating autocomplete, and automatic backlink references for personal knowledge management.

PRO

Smart Note Reminders

Schedule task deadlines and alerts on any note. Receive browser push notifications, sound chimes, and recurring reminders right on time.

Multi-Device Cloud Sync

Seamless background cloud sync keeps your active notes and workspace tabs identical across mobile phones, tablets, laptops, and desktop computers in real-time.

IndexedDB Native Storage

Your workspace is stored locally in asynchronous browser IndexedDB. Supports massive notes and multi-tab workspaces without main-thread blocking or data loss.

Zero-Knowledge Encryption

Share notes with 256-bit AES-GCM encryption. The decryption key resides exclusively in your URL hash (#key=...) and is never sent to the server.

Universal Multi-Format Export

Instant zero-server export to .txt, .md, .json, .csv, .pdf with page numbers, Word .docx, .html, and QR Code.

Off-Thread Web Worker

Live word counts, regex find & replace, casing transforms, and line sorting run inside a dedicated background Web Worker at full 60fps.

100% Offline PWA

Install Outsmart Notes as a desktop or mobile Progressive Web App. Write, format, and organize notes anywhere without an internet connection.

Documentation

Frequently Asked Questions: Create & Edit Markdown (.md) Files Online

Common questions and answers regarding create & edit markdown (.md) files online, syntax, and privacy.

Click the "Preview" button in the secondary toolbar or press the keyboard shortcut Ctrl+Shift+M (Cmd+Shift+M on Mac) to toggle live split-screen rendering.

Yes! Click "Export" in the toolbar to compile your Markdown headings, lists, bold text, links, and code blocks into a beautifully formatted PDF or editable Word (.docx) document.

Type `- [ ] task name` to create an unchecked task or `- [x] task name` to mark it completed. The status bar tracks your completion percentage in real time, and PDF exports render clean graphical vector checkboxes.

Press `/` on any blank line in the editor to open an instant quick-insert menu for headings (H1-H6), task checklists, bullet/numbered lists, code blocks, tables, and wiki links.

Yes. Outsmart Notes continuously auto-saves all notes and tabs to your browser's local IndexedDB database, ensuring zero data loss even if you refresh or close your browser.

The Pro Vault encrypts your selected private notes locally in your browser using 256-bit AES-GCM and PBKDF2 with 100,000 hash iterations. The vault master password never leaves your browser and is never stored on our servers. When locked, even if someone has physical access to your browser, your vault notes cannot be read without your master password.

You can connect your notes wiki-style by typing [[ anywhere in your note. An autocomplete menu will suggest existing notes, or you can type a new title. In Markdown Preview, these links become clickable, allowing instant navigation across your interconnected knowledge base. The Backlinks panel automatically lists every note linking back to the current note.

You can schedule one-time or recurring reminders (daily, weekly, monthly) for any note. Outsmart Notes uses the browser's Web Notifications API to trigger desktop alerts and in-app sound chimes when the reminder is due, with options to view the note, snooze, or mark it completed.

Press / on any blank line to open an instant interactive popup menu. Use your keyboard arrow keys or click to quickly insert headings (H1–H6), task checklists, bullet/numbered lists, syntax-highlighted code blocks, blockquotes, dates, divider lines, and wiki links.

Yes! Click File → Upload / Import Document or drag and drop any file directly into the editor. Outsmart Notes extracts readable text client-side from PDF files (via PDF.js), Word documents (.docx via Mammoth.js), Markdown, TXT, JSON, CSV, and code files with zero server uploads.

Click the microphone icon in the toolbar to activate real-time speech dictation. Outsmart Notes uses your browser's Web Speech API to convert your voice into text on the fly, complete with a live recording waveform indicator.

Zen Focus Mode (press F10 or click Zen Mode) eliminates all toolbars and distraction elements for a clean fullscreen writing experience. When Typewriter Scrolling is enabled, the line you are currently typing stays automatically centered vertically on your screen.

Press Ctrl+K (or Cmd+K on macOS) to open the Spotlight Quick Switcher. You can search notes by title, search text content, filter by #tag, switch active tabs instantly, and run editor commands without lifting your hands from the keyboard.

Outsmart Notes automatically saves snapshot revisions of your notes in local IndexedDB. Press Ctrl+H or select Edit → Version History to preview past versions, inspect character differences, and restore any previous version with a single click.

When you generate a share link, your browser encrypts the note locally using the Web Crypto API (AES-GCM 256-bit). Only the encrypted ciphertext is saved temporarily to our database. The decryption key is appended to the link after the # hash symbol (e.g. #key=...). Because browsers never send URL hashes to web servers, only people you give the link to can decrypt the note.

Outsmart Notes uses IndexedDB as its primary storage engine. Unlike synchronous localStorage, IndexedDB is asynchronous, supports multi-megabyte documents, and prevents any user-interface freezes during auto-saving.

Type - [ ] Task name to create an interactive task item, or - [x] Task name to mark it completed. The status bar automatically tracks your real-time completion progress (e.g. 2/4 tasks (50%)). When you export your note to PDF or Word (.docx), tasks automatically render with clean graphical vector checkboxes and styled typography.

Outsmart Notes features a universal client-side document compiler. Markdown symbols like **bold**, *italic*, `inline code`, ~~strikethrough~~, [Link Title](url), and - [ ] checkboxes are automatically interpreted into styled typography, clickable hyperlinks, and clean vector boxes when exporting to PDF, Microsoft Word (.docx), and HTML with zero server uploads.

Yes! Outsmart Notes is a Progressive Web App (PWA). In Chrome, Edge, Safari, or mobile browsers, click the Install / Add to Home Screen icon to install it as a standalone, offline-ready desktop or mobile application.