Media
3 items
Description
Google Docs style comments on Markdown files in GitHub repositories, stored inside the file itself. Reviewing a design doc in a pull request means arguing about diffs. Moving it to Google Docs means it stops living in the repository. Markdown Comments keeps the document where it belongs and adds the part that was missing: select a phrase, say something about it, get a reply. HOW IT WORKS Open any Markdown file on github.com. Select some text and a Comment button appears. Type, submit, and the comment is committed to the file as a single commit through the GitHub API. Click a highlight to jump to its thread, or a thread to jump to its highlight. Reply, resolve, reopen, or delete. THE COMMENTS LIVE IN THE FILE There is no database, no service, and no sidecar file to lose. A comment is written into the Markdown itself: an invisible anchor around the phrase, and a footnote holding the discussion. Anyone who opens that file on github.com without this extension still sees the entire conversation, rendered as ordinary footnotes. Clone the repository and the comments come with it. WHAT YOU GET - Comments anchored to a phrase, highlighted in the prose - Threaded replies, resolve and reopen - Replies render as Markdown: lists, code blocks, links - Works on any Markdown file, on a repository README, and on a directory README - Follows your GitHub theme, light and dark - Keyboard navigation: j and k between threads, r to reply, e to resolve - Alt+C to show or hide the panel, rebindable - Comments from other people arrive without a reload - If a comment's text gets edited, the extension offers to re-anchor it - If the branch refuses direct commits, it offers to open a pull request instead WHAT IT NEEDS A GitHub personal access token, added in the extension's Options, with Contents: read and write on the repositories you want to comment in. Reading public repositories works with no token at all. PRIVACY No server, no analytics, no telemetry. The extension talks to nothing except GitHub's API, using your token, on your behalf. Full policy: https://github.com/pjdoland/markdown-comments/blob/main/docs/PRIVACY.md The file format is documented and open, so the comments are not locked to this tool: https://github.com/pjdoland/markdown-comments/blob/main/docs/FORMAT.md