Skip to content

Add SwiftUI iOS demo, CLI smoke tests, HTML cleanup, and CI workflow #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
etherlink-intern merged 2 commits into from
May 31, 2026
Merged

Add SwiftUI iOS demo, CLI smoke tests, HTML cleanup, and CI workflow #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df714b7
Refresh README for iOS demo workflow
etherlink-intern May 31, 2026
acfc511
Merge branch 'main' into codex/review-repository-vyyk1r
etherlink-intern May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

SwiftMarkItDown is the start of a native Swift/iOS document-to-Markdown pipeline inspired by Microsoft MarkItDown. The repository is structured around a Swift Package so the same core can be embedded in an iOS app, a macOS utility, or a server-side Swift service. The repo also includes a minimal SwiftUI demo app that exercises the package on iOS.

## Current scope
## What works today

The first milestone focuses on small, deterministic core converters that are safe to run fully on-device:
The current MVP is intentionally small and deterministic so it can run fully on-device:

- `txt` and `md` passthrough with text decoding and blank-line cleanup.
- `html` to Markdown using a lightweight Foundation-based converter for common headings, inline emphasis, links, code, paragraphs, and list items.
- `html` to Markdown for common headings, inline emphasis, links, code, paragraphs, and list items, with document `<head>`, script, and style content ignored.
- `csv` to GitHub-Flavored Markdown tables, including quoted fields and escaped pipes.
- `json` to nested Markdown bullets with stable key ordering.
- A CLI wrapper for local/manual conversion checks.
- A SwiftUI iOS demo app for editing sample input and converting it to Markdown in the simulator.

PDF, DOCX, PPTX, and XLSX are intentionally represented in the format model but return `unsupportedFormat` until their native converter modules are built.
PDF, DOCX, PPTX, and XLSX are represented in the format model but still return `unsupportedFormat` until their native converter modules are implemented.

## Package layout
## Repository layout

```text
Package.swift
Expand Down Expand Up @@ -65,4 +67,4 @@ GitHub Actions runs the same checks on pushes to `main`, pull requests, and manu
2. Add a ZIP/OpenXML package reader as shared infrastructure for DOCX, PPTX, and XLSX.
3. Implement DOCX paragraph, heading, table, hyperlink, and image-reference extraction.
4. Add PDFKit/Vision-backed PDF text and OCR extraction for Apple platforms behind conditional compilation.
5. Layer in iOS app affordances: document picker, share extension, progress reporting, and a pluggable backend escape hatch for heavyweight conversions.
5. Evolve the demo into a more complete iOS MVP with document picker import, share/export flows, progress reporting, and a pluggable backend escape hatch for heavyweight conversions.
Loading