https://github.com/madebysan/markflow
Simple on-the-go markdown reader and editor for iOS.
https://github.com/madebysan/markflow
ios ios-app ios26 markdown native-app swift swiftui xcodegen
Last synced: 15 days ago
JSON representation
Simple on-the-go markdown reader and editor for iOS.
- Host: GitHub
- URL: https://github.com/madebysan/markflow
- Owner: madebysan
- License: mit
- Created: 2026-04-18T19:52:40.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-15T20:12:52.000Z (about 1 month ago)
- Last Synced: 2026-05-15T23:13:01.294Z (about 1 month ago)
- Topics: ios, ios-app, ios26, markdown, native-app, swift, swiftui, xcodegen
- Language: Swift
- Size: 21.7 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Markflow
Simple on-the-go markdown reader and editor for iOS.
Version 0.2.0 · iOS 26 · SwiftUI
Markflow is a native markdown reader and editor for iOS 26. Tap any `.md` file in Files, Mail, or Safari and it opens rendered: code blocks, mermaid diagrams, tables, inline images. Files open read-only by default and edits live in memory until you explicitly choose Save, Save as New File, or Share.
## How it works
Files open in read-only mode by default. Tap the floating eye/pencil glass button at the bottom to switch to Edit. Edits live in memory until you Save (writes to source), Save as New File (file picker), Share, or Export as PDF.
A floating Liquid Glass keyboard toolbar covers headings, bold/italic/strikethrough, links, images (PHPicker → saved sibling to your .md), task/bullet/numbered lists, blockquotes, inline code, code blocks, and rules. Pinch-to-zoom works everywhere: WKWebView zoom in Preview, font scaling in Edit. Swipe from the left edge of an open document to dismiss it.
Settings (gear in Home top-right, or in any document's ••• menu) covers:
- **Appearance** — System / Light / Dark
- **Theme** — 5 curated themes (Indigo, Forest, Sunset, Ocean, Graphite), each with light + dark accents
- **Text** — 6 fonts (System, Rounded, Charter, Monospace, iA Writer, JetBrains Mono); editor + preview size sliders
- **Behavior** — pick whether new files open in Edit or Preview
- **Recents** — last 4 opened files surface on Home; clearable from Settings
## Build from source
Requires Xcode 26 and the iOS 26 simulator runtime.
```bash
cd Markflow
xcodegen generate
xcodebuild -project Markflow.xcodeproj -scheme Markflow \
-destination 'platform=iOS Simulator,name=iPhone 16e' build
```
Or open in Xcode and press ⌘R:
```bash
open Markflow.xcodeproj
```
For a physical-device build, the bundle is signed under Team `QAMM2A6WRQ` (Apple Developer Program). Select your iPhone in Xcode's device picker and hit Run.
## Project layout
File tree
```
md-reader/
├── Markflow.xcodeproj/ # generated by xcodegen
├── project.yml # xcodegen config
├── Markflow/
│ ├── MarkflowApp.swift # @main, WindowGroup { HomeView() }
│ ├── Info.plist # CFBundleDocumentTypes for .md handler
│ ├── Assets.xcassets/ # AppIcon (1024) + HomeIcon (for in-app display)
│ ├── Resources/
│ │ ├── welcome.md # Template shown on Create
│ │ ├── preview.html # HTML template + CSS
│ │ ├── marked.min.js # markdown -> HTML (40 KB)
│ │ ├── highlight.min.js # syntax highlighting (125 KB)
│ │ ├── highlight-github.css
│ │ ├── highlight-github-dark.css
│ │ └── mermaid.min.js # flowcharts (3 MB)
│ └── Views/
│ ├── HomeView.swift # gradient home with Browse/Create CTAs
│ ├── DocumentView.swift # nav bar with picker + share
│ ├── EditView.swift # UITextView + markdown toolbar + pinch font scaling
│ └── PreviewView.swift # WKWebView wrapper
```
## Known limitations
- Relative image paths in markdown (``) don't resolve. Use absolute URLs.
- No "Recents" list on the home screen (dropped when we replaced `DocumentGroup`).
## Support
User support: see [docs/support.md](docs/support.md) or email [hi@santiagoalonso.com](mailto:hi@santiagoalonso.com).
Bug reports and feature requests: [open an issue](https://github.com/madebysan/markflow/issues).
## Acknowledgements
Rendering libraries, vendored in `Markflow/Resources/`:
- [marked](https://github.com/markedjs/marked) for markdown parsing
- [highlight.js](https://github.com/highlightjs/highlight.js) for syntax highlighting
- [Mermaid](https://github.com/mermaid-js/mermaid) for diagrams and flowcharts
Bundled fonts (SIL Open Font License), in `Markflow/Resources/fonts/`:
- [iA Writer Quattro S](https://github.com/iaolo/iA-Fonts) by iA Inc.
- [JetBrains Mono](https://github.com/JetBrains/JetBrainsMono) by JetBrains
## License
[MIT](LICENSE)
---
Made by [santiagoalonso.com](https://santiagoalonso.com)