{"id":50782328,"url":"https://github.com/jzone3/markdown-quicklook","last_synced_at":"2026-06-12T04:31:27.606Z","repository":{"id":362360939,"uuid":"1256486905","full_name":"jzone3/markdown-quicklook","owner":"jzone3","description":"macOS Quick Look extension that renders Markdown files when you press spacebar in Finder","archived":false,"fork":false,"pushed_at":"2026-06-03T21:55:01.000Z","size":4542,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-03T22:17:47.126Z","etag":null,"topics":["appkit","built-by-devin","finder","macos","markdown","quicklook","quicklook-extension","swift"],"latest_commit_sha":null,"homepage":null,"language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jzone3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-06-01T20:31:07.000Z","updated_at":"2026-06-02T00:10:32.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jzone3/markdown-quicklook","commit_stats":null,"previous_names":["jzone3/markdown-quicklook"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/jzone3/markdown-quicklook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jzone3%2Fmarkdown-quicklook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jzone3%2Fmarkdown-quicklook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jzone3%2Fmarkdown-quicklook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jzone3%2Fmarkdown-quicklook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jzone3","download_url":"https://codeload.github.com/jzone3/markdown-quicklook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jzone3%2Fmarkdown-quicklook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34229624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appkit","built-by-devin","finder","macos","markdown","quicklook","quicklook-extension","swift"],"created_at":"2026-06-12T04:31:26.941Z","updated_at":"2026-06-12T04:31:27.588Z","avatar_url":"https://github.com/jzone3.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown QuickLook\n\n[![Built by Devin](https://raw.githubusercontent.com/club-cog/built-by-devin/main/badges/built-by-devin.svg)](https://devin.ai)\n\nMarkdown QuickLook is a macOS Quick Look extension that renders `.md` files when you press **spacebar** in Finder.\n\nIt supports headings, lists, task lists, inline formatting, code blocks, blockquotes, and native AppKit-rendered tables.\n\n![Demo: pressing spacebar on Markdown files in Finder shows rendered Quick Look previews with headings, code blocks, tables, and task lists](assets/markdown-quicklook-demo.gif)\n\n## Download\n\n- **Landing page:** https://quicklookmd.com\n- **Direct download:** [latest `MarkdownQuickLook.dmg`](https://github.com/jzone3/markdown-quicklook/releases/latest/download/MarkdownQuickLook.dmg)\n\nOpen the `.dmg`, drag **Markdown QuickLook** into `Applications`, and launch it once.\nThe app registers and enables its Quick Look extension automatically. Releases are\ncode signed with a Developer ID certificate and notarized by Apple, so the app\nopens without Gatekeeper warnings.\n\n## Recommended install (via an agent)\n\nIf you'd rather build from source, the easiest way is to ask **Devin** or another local coding agent to do it for you.\n\nQuick Look extensions require a few Mac-specific steps that agents are good at handling:\n\n- generating the Xcode project with XcodeGen\n- building/signing the app and extension\n- copying the app to `~/Applications`\n- registering/enabling the Quick Look extension\n- resetting Quick Look caches\n- testing the preview with `qlmanage`\n\nGive your agent this file:\n\n```text\nagent-instructions/INSTALL.md\n```\n\nExample prompt:\n\n```text\nClone https://github.com/jzone3/markdown-quicklook and follow agent-instructions/INSTALL.md to install and test the Quick Look extension.\n```\n\n## Manual install\n\nIf you want to install manually:\n\n```bash\ngit clone https://github.com/jzone3/markdown-quicklook.git\ncd markdown-quicklook\nbrew install xcodegen\nxcodegen generate\nopen MarkdownQuickLook.xcodeproj\n```\n\nThen in Xcode:\n\n1. Select the `MarkdownQuickLook` target and set your signing Team.\n2. Select the `QuickLookExtension` target and set the same signing Team.\n3. Build and run the `MarkdownQuickLook` scheme once.\n4. Open System Settings → General → Login Items \u0026 Extensions → Quick Look.\n5. Enable **Markdown Preview**.\n6. Select a `.md` file in Finder and press **spacebar**.\n\nIf the preview does not update:\n\n```bash\nqlmanage -r\nqlmanage -r cache\n```\n\n## Features\n\n- Native macOS Quick Look preview extension\n- Menu bar helper app, no Dock icon\n- Headings, paragraphs, blockquotes, lists, task lists, links, inline code, bold, italic, strikethrough\n- Native AppKit table rendering with `NSTextTable`\n- Sandboxed extension with no network access required\n- Separate Swift package that can render Markdown to self-contained HTML\n- `mdql` CLI for rendering Markdown files to HTML\n\n## Development\n\nGenerate the Xcode project:\n\n```bash\nbrew install xcodegen\nxcodegen generate\n```\n\nRun package tests:\n\n```bash\nswift test\n```\n\nRender Markdown to HTML with the CLI:\n\n```bash\nswift run mdql Examples/sample.md preview.html\n```\n\nBuild the app from Terminal if signing is already configured:\n\n```bash\nxcodebuild \\\n  -project MarkdownQuickLook.xcodeproj \\\n  -scheme MarkdownQuickLook \\\n  -configuration Debug \\\n  -derivedDataPath .derivedData-signed \\\n  build\n```\n\n## Landing page\n\nThe landing page (https://quicklookmd.com) is **not** part of this branch. Its\nsource is maintained separately on the [`gh-pages`](https://github.com/jzone3/markdown-quicklook/tree/gh-pages)\nbranch, which GitHub Pages serves directly. `master` is kept clean as the\nbuildable open-source project. See `AGENTS.md` for details.\n\n## How it works\n\n```text\nFinder spacebar\n  -\u003e QuickLookExtension.appex\n  -\u003e PreviewViewController\n  -\u003e read Markdown file\n  -\u003e render native NSAttributedString\n  -\u003e display in NSTextView inside NSScrollView\n```\n\nThe extension intentionally avoids `WKWebView` because WebKit helper processes can be fragile inside Quick Look extension sandboxes.\n\n## Agent notes\n\nAgents working in this repo should read `AGENTS.md` first.\n\nAgents installing this for a user should follow `agent-instructions/INSTALL.md`.\n\n## License\n\n[MIT](LICENSE). Bundled assets and dependencies retain their own permissive licenses; see [`THIRD_PARTY_LICENSES.md`](THIRD_PARTY_LICENSES.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjzone3%2Fmarkdown-quicklook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjzone3%2Fmarkdown-quicklook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjzone3%2Fmarkdown-quicklook/lists"}