Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@ interesting version of this idea is bigger than one app and one platform.
**The macOS app is ready today. Ports, shared foundations, new workflows, and
surprising ideas are welcome.**

<p align="center">
<a href="assets/screenshots/previewmd-reading-workspace.png">
<img src="assets/screenshots/previewmd-reading-workspace.png" width="1200" alt="PreviewMD on macOS displaying a polished Markdown document with tabs, search, badges, and a project table">
</a>
</p>

<p align="center">
<sub>A calm native workspace for reading, navigating, and understanding Markdown.</sub>
</p>

## Why it is fun to work on

PreviewMD sits at an unusually good intersection:
Expand Down Expand Up @@ -60,6 +70,21 @@ porting experiment can all be excellent first changes.
- PDF export, printing, rich copy, and DOCX export
- Fully local rendering with pinned resources — documents never leave the Mac

## Source and preview stay in sync

Move between source, split, and document views without giving up typography,
math, syntax highlighting, callouts, or diagrams.

<p align="center">
<a href="assets/screenshots/previewmd-split-view.png">
<img src="assets/screenshots/previewmd-split-view.png" width="1200" alt="PreviewMD split view showing Markdown source beside rendered math, Swift code, a callout, and a sequence diagram">
</a>
</p>

<p align="center">
<sub>Source on the left, finished document on the right — rendered entirely offline.</sub>
</p>

## Try it locally

You need macOS 14 or newer, Xcode with Swift 6.1 support, and the Xcode command
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshots/previewmd-split-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.