Getting Started
MDash is a browser-based Markdown workspace. You can begin without an account, and vault documents save in the current browser.
Table of Contents
Create Your First Document
- Choose New File in the Vault panel or press
Ctrl/⌘ + Alt + N. - Give the document a clear name.
- Add a small amount of Markdown in the editor.
- Choose Split to see the source and rendered document together.
- Check the footer for Saved locally before closing the page.
Markdown Source
**Project Check-In**
- [x] Gather requirements
- [ ] Review the first draft
See [[Project Plan]] for the next steps.
Rendered Result
Project Check-In
- Gather requirements
- Review the first draft
See [[Project Plan]] for the next steps.
The wiki-link remains unresolved until a file named Project Plan.md exists. You can create it later by opening the link.
The bundled /MDash folder contains this README and the complete guide set. Bundled files are read-only, so duplicate one when you want an editable copy.
Understand Automatic Saving
MDash saves vault edits automatically after you pause typing. There is no separate Save command.
The footer reports Saving locally, Saved locally, or Save failed. A failed save also opens a persistent warning with a retry action. Keep the page open until an important change reports Saved locally.
Browser storage is convenient, but it is not a backup. Export work you cannot replace. Import, Export, and Backup explains ZIP exports and complete restore points.
Choose a Writing View
| View | Best For |
|---|---|
| Editor | Maximum space for Markdown source |
| Split | Source and Preview side by side |
| Stacked | Source above Preview, especially on narrow screens |
| Preview | Focused reading and review |
MDash remembers the view for each open tab. On a compact screen, Split temporarily uses the Stacked layout without changing the saved desktop choice.
Use Synced Scroll in a split view to follow matching source lines. Use Focus Mode to hide application chrome, and use browser fullscreen when you want the browser window itself to fill the screen.
Use the Editing Tools
The toolbar covers headings, emphasis, text alignment, lists, tables, links, images, equations, diagrams, alerts, dates, references, metadata, emoji, and symbols.
Most formatting actions transform the current selection. With no selection, they insert a useful starting form and place the cursor where you can continue. Open Insert Code Block, Insert Table, Insert Equation, or Insert Diagram for a guided editor with a live preview.
Use the command palette with Ctrl/⌘ + Shift + P when you prefer the keyboard or cannot find an action. The Markdown Guide pairs the most useful Markdown source with its rendered result.
For text alignment, place the cursor in a paragraph or select text, open Text Alignment, then choose Left, Center, or Right. Inside aligned content, the same menu offers Remove Alignment. An empty wrapper has one blank typing line. The Markdown Guide explains compact wrappers, safe insertion, and compatibility with other Markdown viewers. Document Direction remains in Edit Metadata.
Find What You Need
- Press
Ctrl/⌘ + Fto find and replace in the current document. Preview uses search-only controls. - Press
Ctrl/⌘ + Pto open a vault file by name. - Press
Ctrl/⌘ + Shift + Fto search across file contents. - Press
/on a public documentation page to search guide titles and full guide content. - Open Outline for headings in the current document and Backlinks for notes that refer to it.
The Vault Workflow guide covers folders, tabs, Favorites, Recent files, Trash, Vault Organizer, and link-safe moves.
Install and Work Offline
Install MDash as a Progressive Web App from a supported browser when you want a dedicated window or home-screen entry. The core application works offline after its assets have been cached.
KaTeX, Mermaid, and Shiki load only when a document needs them. Open Settings, choose Offline, and download the Offline Feature Pack while connected if you need every bundled rendering asset available offline.
An installed app still uses storage from its browser profile and site origin. It does not synchronize a vault to another browser or device. Read Privacy and Local Storage before clearing site data or moving to a new device.
Before You Leave
Before finishing your first session:
- Create a folder for the documents you made.
- Try Quick Open and Search All Files.
- Open the wiki-link you added and create its note.
- Create a full backup and keep it outside the browser.
Choose Your Next Guide
| Goal | Read Next |
|---|---|
| Learn Markdown syntax | Markdown Guide |
| Organize files and tabs | Vault Workflow |
| Add math, diagrams, or code | Math and KaTeX, Mermaid Diagrams, or Code and Syntax Highlighting |
| Connect notes | Wiki-Links |
| Move or protect work | Import, Export, and Backup and Privacy and Local Storage |