Brandon Lucas
d30d2efa4e
- Rename grapho → pal across entire codebase (CLI, NixOS module, flake, docs, config paths) - Add `pal onboard` interactive setup wizard with 4 steps: device, config repo, sync, backups - Shows current setup summary when re-running onboard on an existing installation with warnings about what will change - Fix askConfirm/askInput to read from /dev/tty so interactive prompts work correctly - Remove || operator usage in askConfirm (not reliable in Lux) - Add pal package to nix develop shell - Document ~/.config/pal/ directory structure in README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
239 lines
6.0 KiB
Markdown
239 lines
6.0 KiB
Markdown
# Markdown Editors for pal
|
|
|
|
This document covers recommended markdown editors for use with pal across desktop and mobile platforms.
|
|
|
|
## Recommended: md (PWA)
|
|
|
|
**URL:** https://md-ashy.vercel.app
|
|
|
|
A lightweight, browser-based markdown editor that works on both desktop and mobile.
|
|
|
|
### Features
|
|
- WYSIWYG editing with inline markdown transformation
|
|
- Source mode toggle for raw editing
|
|
- Offline support via PWA (installable as app)
|
|
- Dark theme
|
|
- File drag-and-drop support
|
|
- Share documents via compressed URL links
|
|
- GitHub Flavored Markdown (GFM) support including tables and task lists
|
|
- Syntax highlighting for code blocks
|
|
- Keyboard shortcuts (Ctrl+S to download, Ctrl+B/I for formatting)
|
|
|
|
### Why It's Good for pal
|
|
- Works on any device with a browser
|
|
- Can be installed as a PWA on mobile home screen
|
|
- No account required
|
|
- Files stay local (privacy-first)
|
|
- Can edit files from Syncthing-synced folders
|
|
|
|
### Setup
|
|
1. Visit https://md-ashy.vercel.app
|
|
2. Click the install prompt (or use browser menu > "Add to Home Screen")
|
|
3. Open markdown files from your synced folders
|
|
|
|
---
|
|
|
|
## Desktop Editors
|
|
|
|
### MarkText (Recommended for Desktop)
|
|
**Open Source** | **Cross-platform** | [GitHub](https://github.com/marktext/marktext)
|
|
|
|
A simple, elegant markdown editor with real-time preview.
|
|
|
|
**Pros:**
|
|
- Clean, distraction-free interface
|
|
- WYSIWYG preview (like Typora, but free)
|
|
- Multiple editing modes: Source, Typewriter, Focus
|
|
- Six themes (light/dark variants)
|
|
- Supports CommonMark, GFM, and Pandoc markdown
|
|
- Diagrams (flowcharts, sequence, Gantt via Mermaid)
|
|
- Math expressions via KaTeX
|
|
- Auto-save and file recovery
|
|
|
|
**Cons:**
|
|
- Last release was March 2022 (minimally maintained)
|
|
- No mobile version
|
|
|
|
**Best for:** Writers who want a polished, free Typora alternative.
|
|
|
|
---
|
|
|
|
### Visual Studio Code
|
|
**Open Source** | **Cross-platform** | [Website](https://code.visualstudio.com)
|
|
|
|
The developer's Swiss Army knife with excellent markdown support.
|
|
|
|
**Pros:**
|
|
- Built-in markdown preview
|
|
- Extensive extension ecosystem (markdownlint, Markdown All in One, etc.)
|
|
- Git integration built-in
|
|
- Works with any programming workflow
|
|
- Highly customizable
|
|
|
|
**Cons:**
|
|
- Resource-heavy for just markdown editing
|
|
- Can feel like overkill for simple notes
|
|
|
|
**Best for:** Developers who want one editor for code and notes.
|
|
|
|
---
|
|
|
|
### Obsidian
|
|
**Freemium** | **Cross-platform** | [Website](https://obsidian.md)
|
|
|
|
A powerful knowledge base that works on local markdown files.
|
|
|
|
**Pros:**
|
|
- Bidirectional linking between notes
|
|
- Graph view of note connections
|
|
- Extensive plugin ecosystem (900+ plugins)
|
|
- Local-first, privacy-focused
|
|
- Mobile apps (iOS/Android)
|
|
- Sync available (paid) or use Syncthing
|
|
|
|
**Cons:**
|
|
- Not fully open source (free for personal use)
|
|
- Learning curve for advanced features
|
|
- Can become complex with too many plugins
|
|
|
|
**Best for:** Building a personal knowledge base / "second brain".
|
|
|
|
---
|
|
|
|
### Zettlr
|
|
**Open Source** | **Cross-platform** | [Website](https://www.zettlr.com)
|
|
|
|
Built for academics and researchers.
|
|
|
|
**Pros:**
|
|
- Built-in citation management (Zotero integration)
|
|
- Footnotes and LaTeX support
|
|
- Zettelkasten method support
|
|
- Export to PDF, Word, LaTeX via Pandoc
|
|
- Focus on long-form writing
|
|
|
|
**Cons:**
|
|
- No mobile app
|
|
- Steeper learning curve
|
|
- Requires Pandoc for some exports
|
|
|
|
**Best for:** Academic writing, research papers, thesis work.
|
|
|
|
---
|
|
|
|
### Joplin
|
|
**Open Source** | **Cross-platform** | [Website](https://joplinapp.org)
|
|
|
|
Note-taking with sync and mobile apps.
|
|
|
|
**Pros:**
|
|
- End-to-end encryption
|
|
- Mobile apps (iOS/Android)
|
|
- Sync with Nextcloud, Dropbox, OneDrive, WebDAV
|
|
- Import from Evernote
|
|
- Notebooks and tagging
|
|
- Web clipper extension
|
|
|
|
**Cons:**
|
|
- Notes stored in SQLite database, not plain files
|
|
- Can be resource-intensive
|
|
- Less suited for power users who want plain markdown
|
|
|
|
**Best for:** Evernote replacement with cross-platform sync.
|
|
|
|
---
|
|
|
|
## Mobile Editors
|
|
|
|
### Markor (Android)
|
|
**Open Source** | [GitHub](https://github.com/gsantner/markor)
|
|
|
|
The best open-source markdown editor for Android.
|
|
|
|
**Pros:**
|
|
- Works with any folder (including Syncthing)
|
|
- No account required
|
|
- Supports markdown, todo.txt, and more
|
|
- Offline-first
|
|
|
|
**Best for:** pal users on Android.
|
|
|
|
### iA Writer (iOS/Android)
|
|
**Paid** | [Website](https://ia.net/writer)
|
|
|
|
Premium minimalist writing experience.
|
|
|
|
**Pros:**
|
|
- Beautiful, distraction-free interface
|
|
- Works with iCloud/Dropbox folders
|
|
- Focus mode highlights current sentence
|
|
|
|
**Cons:**
|
|
- Paid app
|
|
- File management less flexible than Markor
|
|
|
|
**Best for:** iOS users who value polish.
|
|
|
|
### Obsidian Mobile (iOS/Android)
|
|
**Free** | [Website](https://obsidian.md)
|
|
|
|
Mobile companion to Obsidian desktop.
|
|
|
|
**Pros:**
|
|
- Full Obsidian features on mobile
|
|
- Sync via iCloud, Obsidian Sync, or Syncthing
|
|
|
|
**Best for:** Existing Obsidian users.
|
|
|
|
---
|
|
|
|
## Recommendation for pal Users
|
|
|
|
### Simple Setup (Recommended)
|
|
1. **Desktop:** MarkText or VS Code
|
|
2. **Mobile:** md PWA (https://md-ashy.vercel.app) or Markor (Android)
|
|
3. **Sync:** Syncthing (already part of pal)
|
|
|
|
### Power User Setup
|
|
1. **Desktop:** Obsidian with Syncthing sync
|
|
2. **Mobile:** Obsidian Mobile
|
|
3. **Notes in:** `~/.nb/` or a dedicated Syncthing folder
|
|
|
|
### Academic Setup
|
|
1. **Desktop:** Zettlr with Zotero
|
|
2. **Mobile:** md PWA for quick edits
|
|
3. **Export:** Pandoc for final documents
|
|
|
|
---
|
|
|
|
## Integration with pal
|
|
|
|
All recommended editors work with plain markdown files, which means:
|
|
|
|
1. Store notes in an `nb` notebook or Syncthing folder
|
|
2. Edit with any editor on any device
|
|
3. Changes sync automatically via Syncthing
|
|
4. Backup happens via restic
|
|
|
|
Example workflow:
|
|
```bash
|
|
# Create a note with nb
|
|
nb add "Meeting notes"
|
|
|
|
# Edit in your preferred editor
|
|
marktext ~/.nb/home/meeting-notes.md
|
|
|
|
# Or on mobile, open the same file via Syncthing folder
|
|
# Sync happens automatically
|
|
pal sync
|
|
```
|
|
|
|
## Sources
|
|
|
|
- [MarkText GitHub](https://github.com/marktext/marktext)
|
|
- [Obsidian](https://obsidian.md)
|
|
- [Zettlr](https://www.zettlr.com)
|
|
- [Joplin](https://joplinapp.org)
|
|
- [awesome-markdown-editors](https://github.com/mundimark/awesome-markdown-editors)
|
|
- [Markdown Guide Tools](https://www.markdownguide.org/tools/)
|