Proposal: add a 'Related extensions / Helpers' section to README

[yunho0130]

Hi MarkEdit team — thanks again for both MarkEdit and MarkEdit-preview. We use them daily and the preview extension is, in our team's opinion, the single feature that brings MarkEdit closest to a "best Markdown editor on macOS" experience.

Following the contribution guideline in the README ("please discuss the proposal before making changes"), I'd like to ask for your opinion before opening a PR.

Background

While onboarding teammates to MarkEdit + MarkEdit-preview, we noticed two small UX paper cuts around mode switching:

1. The toolbar View Mode item always opens a dropdown menu, even for users who only want to flip between Edit and Preview.
2. ⇧⌘V (Change Mode) cycles through the three default modes (edit → side-by-side → preview) rather than a clean two-state toggle.

Both are intentional defaults and easy to override via settings.json. But the JSON snippet involves two coordinated keys (editor.customToolbarItems and extension.markeditPreview.changeMode.modes), and not everyone knows where to start.

What we built

We packaged the override as a tiny installer extension so users can apply it from the Extensions menu without editing JSON manually:

→ https://github.com/Squarelight-ai/markedit-direct-preview

• ~5 KB CJS bundle dropped into scripts/
• Adds Extensions → Direct Preview → Apply / Revert One-Click Toggle Setup
• "Apply" merges the standard customToolbarItems eye icon + changeMode.modes = ["edit","preview"] into the user's settings.json
• Built with markedit-api, MIT licensed, fully attributing upstream MarkEdit / MarkEdit-preview / markedit-api in NOTICE
• It does not reimplement preview rendering or mode switching — it is a pure setup helper on top of MarkEdit-preview

The README is upfront about the upstream limitations we couldn't work around (static toolbar icon, no split-button, no public API to toggle mode programmatically). We don't want to overstate what it does.

What I'd like to discuss

Would you be open to a small README PR on MarkEdit-preview that adds a section like "Related extensions / Helpers" with a one-line entry pointing to Direct Preview (and any other community helpers you'd want there)? Happy to:

• Draft the section exactly the way you prefer (location, wording, neutral tone).
• Add similar conventions if you'd rather host the list on the MarkEdit-app/MarkEdit wiki Extensions page instead.
• Skip the PR entirely if you'd prefer the list stays in your hands.

If a separate "Helpers" entry feels too narrow, an alternative is just to mention the override pattern (the two JSON keys) inline in the existing Settings section of the README, without linking out to our repo. We're also fine with that outcome.

Thanks for considering — please tell us which path (if any) you'd be comfortable with and I'll prepare a focused PR.

— Yunho Maeng (Squarelight Inc.)

[cyanzhong]

Hi, thanks for reaching out. I checked your project and it looks solid.

I’d be happy to add it as a reference in this project. Feel free to open a PR.