Skip to content

Add Markdown Buddy to the tool directory - #286

Open
japaris wants to merge 2 commits into
mattcone:masterfrom
japaris:add-markdown-buddy
Open

Add Markdown Buddy to the tool directory#286
japaris wants to merge 2 commits into
mattcone:masterfrom
japaris:add-markdown-buddy

Conversation

@japaris

@japaris japaris commented Aug 24, 2026

Copy link
Copy Markdown

Hi Matt, adding Markdown Buddy to the tool directory. I am the developer, and I followed the wiki instructions: duplicated an existing tool page, added an icon and a screenshot.

What it is: a native macOS Markdown editor (Swift and AppKit). The part that is arguably worth a directory entry is that it pushes rendering outside the app itself, via a Quick Look extension that renders .md files in the Finder and an Xcode source editor extension.

On the syntax table: I did not fill it in from the feature list. I ran each of the 28 elements through the app's renderer and recorded what actually came out, so the gaps are in there too:

  • line-breaks is no, trailing spaces do not produce a break.
  • unordered-lists is partial, nested lists are flattened in the preview.
  • heading-ids is no. IDs are generated from the heading text, but the {#custom-id} syntax is not recognized and renders literally.
  • html is no, inline HTML is escaped.
  • Also no for footnotes, definition lists, emoji shortcodes, highlight, subscript, superscript and automatic URL linking.

For disabling-auto-url I used no, following what the other tools without automatic linking do, but tell me if you would rather see something else there.

I kept the description factual and included the limitations in the body text rather than only in the table. Happy to rewrite anything that reads too much like marketing, or to redo the screenshot at a different size.

Native macOS Markdown editor. Adds rendered Quick Look previews in the
Finder and an Xcode source editor extension.

Syntax table filled in by running each element through the app's renderer
(version 2.2.3) rather than from the feature list, so the gaps are
recorded too: no footnotes, definition lists, hard line breaks or
automatic URL linking, inline HTML is escaped, and nested lists are
flattened in the preview.
Three elements reported as missing in the first commit are supported as of
version 2.2.4: hard line breaks from trailing spaces or a backslash, nested
lists, and the {#custom-id} heading syntax.

Filling in this table is what surfaced them. All three were fixed in the app
rather than left as documented gaps, and re-measured the same way, by running
each element through the renderer.
@japaris

japaris commented Aug 24, 2026

Copy link
Copy Markdown
Author

Update pushed, and it comes with a caveat you should decide on rather than me.

Filling in the syntax table for this PR is what made me actually measure the renderer instead of trusting the feature list, and three of the gaps I reported turned out to be worth fixing rather than documenting. So they are fixed:

Element Was Now
line-breaks no yes, trailing spaces and backslash
unordered-lists partial yes, nested lists render as nested lists
heading-ids no yes, {#custom-id} is recognized

Nothing else moved. I re-ran all 28 elements through the renderer the same way to be sure the changes did not shift anything I had already reported.

The caveat: these three landed in version 2.2.4, which is not on the App Store yet. Version 2.2.3 is in review right now and 2.2.4 goes out after it, so realistically a few days to a couple of weeks. The table as it now stands describes a version nobody can install today.

I would rather you know that than merge something briefly inaccurate. Two options, entirely your call:

  • Hold the PR until 2.2.4 is live and I comment here to confirm. My preference, and the honest one.
  • Merge whenever suits you, and if 2.2.4 slips I will open a follow-up reverting those three rows.

Either way I will comment here when it is actually shipped, so there is a dated record rather than a promise.

@japaris

japaris commented Aug 25, 2026

Copy link
Copy Markdown
Author

Status update, since I said I would keep a dated record here rather than a promise.

2.2.4 was submitted to Apple today and is now in review. It is not on sale yet, so the three rows this PR changes are still ahead of reality by a few days.

I am not claiming the debt is settled: I will comment again when the version is actually live, which is the point at which the table becomes accurate. Apple has been turning these around in about a day lately, so this should be short. If you would rather merge before then, the window where the table is wrong is small; if you prefer to wait for my confirmation, that is the safer read and I understand it.

Nothing for you to do either way.

@japaris

japaris commented Aug 25, 2026

Copy link
Copy Markdown
Author

Confirming, as promised: 2.2.4 is live on the Mac App Store as of today. Apple approved it and it is READY_FOR_SALE.

The three rows this PR changes are now accurate rather than ahead of reality:

  • line-breaks — yes, two trailing spaces or a backslash
  • unordered-lists — yes, nested lists render as nested lists
  • heading-ids — yes, {#custom-id} is recognized

Nothing else in the table moved; I re-ran all 28 elements through the renderer after the fixes to be sure.

So the PR is ready whenever you are, with no caveat left. Thanks for your patience, and no rush at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant