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
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,16 @@
<a href="https://lastobelus.github.io/markover/agents/">For agents</a>
</p>

Markover is an **Early macOS preview** for reviewing Markdown as a document
tree and returning block-level feedback to an agent.
Markover is a macOS app for reviewing Markdown as a document tree and
returning block-level feedback to an agent. Instead of quoting fragments back
into chat, feedback stays attached to the blocks it concerns, and the agent
retrieves the whole review in a single structured handoff.

<p align="center">
<img src="./docs/user/assets/markover-review-editor@2x.png" width="920" alt="Markover showing a document inbox, structured Markdown, and an annotation with labeled screenshots.">
</p>
Markover is in **early preview**. It is free and MIT-licensed, requires no
account, and keeps ordinary review data in your macOS account.

<p align="center">
<img src="./docs/user/assets/markover-annotation-browser@2x.png" width="920" alt="Markover showing every rendered annotation in the active document.">
<a href="https://lastobelus.github.io/markover/#demo"><img src="./docs/user/assets/markover-review-editor@2x.png" width="920" alt="Markover in Ember Light showing the review inbox, a launch brief in the center document tree, and an annotation with two labeled attachments."></a>
</p>

## Features
Expand All @@ -37,6 +38,14 @@ tree and returning block-level feedback to an agent.
- One-shot agent handoff containing the exact source, checksum, document tree,
annotations, attachments, and review context.

## Try it

Ask your agent to open a Markdown document in Markover (the command it needs
is below), review the document, then tell the agent "Check Markover." To
review a document without an agent, choose **File → Open Markdown…** in the
app. The [user guide](https://lastobelus.github.io/markover/guide/) covers the
full workflow and keyboard controls.

## Before you try the early preview

- Markover supports macOS 14 Sonoma or newer on Apple Silicon Macs. Native
Expand All @@ -46,7 +55,8 @@ tree and returning block-level feedback to an agent.
notarized. macOS is expected to block the first launch.
- Ordinary review work stays in your macOS account. Markover has no telemetry,
analytics, cloud sync, or automatic review upload.
- Unreleased prototype formats may change directly. Released review schemas
- Data formats from unreleased prototype builds may change without migration
support. Released review schemas
are converted automatically with an original backup; unknown future
versions remain untouched until a compatible Markover release opens them.
Back up important review data before changing versions.
Expand All @@ -68,14 +78,16 @@ npx --yes \
--summary "Explain why this document exists and what feedback would help."
```

The public npm package named `markover` is unrelated to this project. Use the
exact GitHub release-package URL above.

The command downloads the Apple Silicon app on first use. Native Intel releases
are deferred to the Broad announcement roadmap in
[issue #80](https://github.com/lastobelus/markover/issues/80).
Release launchers produced from the hardened preflight verify its checksum,
bundle identity, version, architecture, Sonoma floor, ad-hoc signature, and
code seal before moving it into the cache. Later commands reuse that validated
version. The launcher returns a review ID, status, and OS-openable custom URL,
then exits without waiting for the review:
are deferred; see [issue #80](https://github.com/lastobelus/markover/issues/80).
The launcher verifies the download's checksum, bundle identity, version,
architecture, minimum macOS version, ad-hoc signature, and code seal before
caching it. Later commands reuse that validated version. The launcher returns
a review ID, a status, and a `markover://` URL that macOS can open, then exits
without waiting for the review:

```json
{"reviewId":"mko_8f3a2c","status":"editing","reviewUrl":"markover://review/mko_8f3a2c"}
Expand All @@ -87,8 +99,8 @@ put the reliable Terminal fallback on its own line:

`open 'markover://review/mko_8f3a2c'`

Custom-scheme Markdown links depend on the thread-host; T3 Code and the Codex app do not
currently dispatch them. Then stop. See the dedicated [agent
Some chat apps, including T3 Code and the Codex app, do not currently open
custom-scheme links from Markdown. Then stop. See the dedicated [agent
workflow](https://lastobelus.github.io/markover/agents/) for retrieval,
reopening, and interpretation guidance.

Expand Down Expand Up @@ -130,4 +142,4 @@ operations.
- [Discussions](https://github.com/lastobelus/markover/discussions) for early
ideas, usage questions, and general support
- [Report a problem](https://github.com/lastobelus/markover/issues/new?template=bug.yml)
with the smallest sanitized reproduction of a defect
with the smallest sanitized reproduction
6 changes: 3 additions & 3 deletions design/brand/markover-readme-leader.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading