{"id":46114821,"url":"https://github.com/newuni/md-viewer","last_synced_at":"2026-05-05T10:01:59.993Z","repository":{"id":340949128,"uuid":"1168310465","full_name":"newuni/md-viewer","owner":"newuni","description":"Native macOS Markdown viewer with Finder Quick Look extension, live preview, and CLI export.","archived":false,"fork":false,"pushed_at":"2026-03-05T22:10:29.000Z","size":1115,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-06T01:36:38.683Z","etag":null,"topics":["cli","finder","macos","markdown","quicklook","swift"],"latest_commit_sha":null,"homepage":"https://github.com/newuni/md-viewer/releases/latest","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/newuni.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"ROADMAP.md","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-02-27T08:39:25.000Z","updated_at":"2026-03-05T22:10:30.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/newuni/md-viewer","commit_stats":null,"previous_names":["newuni/md-viewer"],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/newuni/md-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newuni%2Fmd-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newuni%2Fmd-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newuni%2Fmd-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newuni%2Fmd-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/newuni","download_url":"https://codeload.github.com/newuni/md-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newuni%2Fmd-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32644188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"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":["cli","finder","macos","markdown","quicklook","swift"],"created_at":"2026-03-01T23:08:40.738Z","updated_at":"2026-05-05T10:01:59.983Z","avatar_url":"https://github.com/newuni.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MDViewer\n\nNative macOS Markdown preview utility with Finder Quick Look support.\n\n## Why\n\nmacOS preview support for `.md` files is inconsistent across tools and workflows. `MDViewer` provides:\n\n- A lightweight native Markdown viewer app.\n- A Quick Look extension to preview Markdown directly in Finder.\n- A small CLI (`md-viewer`) for opening files or exporting HTML.\n\n## Features\n\n- Native renderer path (attributed text) is the default in app and Quick Look.\n- Theme + appearance + typography controls (System/GitHub/Solarized/Dracula, Light/Dark/System, body/code sizes).\n- Automatic render tiers (`small`/`medium`/`large`/`huge`) with manual Fast Mode override.\n- Render `.md` and `.markdown` files with app-level viewing.\n- Quick Look extension (`space` in Finder) for Markdown previews.\n- HTML export from CLI for debugging and integrations.\n- Basic HTML sanitization to strip active script content.\n- Automatic heading anchors so table-of-contents links (`#...`) work.\n- Lightweight syntax highlighting for fenced code blocks (Swift/JS/TS/Python/Shell/SQL).\n- Mermaid diagram support for fenced code blocks using automatic HTML/WebView fallback.\n- Live preview refresh when the source file changes on disk.\n- Find-in-document (`Cmd+F`) with next/previous navigation and case-sensitive toggle.\n- Collapsible outline sidebar for heading navigation (`h1`-`h4`) with active-section sync while you scroll.\n- Copy-link action for headings directly from the outline context menu.\n- Command Palette (`Cmd+K`) for quick actions (outline/theme/fast mode/open/export/reading mode/paste preview).\n- Ultra-clean Reading Mode (`Ctrl+Cmd+R`) with centered text and hidden chrome.\n- Quick paste-preview (`Cmd+Shift+V`) to open Markdown from clipboard without creating a file.\n- Typography zoom shortcuts (`Cmd+=`, `Cmd+-`, `Cmd+0`).\n- Large-file handling with automatic tiers and optional manual fast mode override.\n- Front matter support (`--- ... ---`) without rendering it as document content.\n- GitHub-flavored Markdown baseline support (tables, task lists, strikethrough).\n- Enriched Quick Look preview metadata (title/description/keywords extraction).\n\nMermaid rendering is provided in HTML mode and uses the Mermaid browser runtime from jsDelivr.\n\n## Requirements\n\n- macOS 14+\n- Xcode (full app build)\n- Swift 6.0+\n\n## Local development\n\n1. Install dependencies:\n\n```bash\nbrew install xcodegen\n```\n\n2. Generate Xcode project:\n\n```bash\n./scripts/generate_xcodeproj.sh\n```\n\n3. Build/test core package:\n\n```bash\nswift test\n```\n\n4. Open project:\n\n```bash\nopen MDViewer.xcodeproj\n```\n\n## CLI usage\n\n```bash\nswift run md-viewer --help\nswift run md-viewer README.md\nswift run md-viewer --export-html README.md -o README.html\n```\n\n## Installation from releases\n\nEach release publishes `MDViewer.app.zip` and `MDViewer.app.zip.sha256`.\n\nThis project currently ships unsigned and not notarized binaries. On first run, Gatekeeper may block the app.\n\nIf needed:\n\n```bash\nxattr -dr com.apple.quarantine /Applications/MDViewer.app\n```\n\n## Quick Look behavior\n\nPressing `space` in Finder should render Markdown directly with the extension. The `Open with MDViewer` button is system UI and cannot be removed, but you should not need to click it for preview.\n\nImportant: Quick Look extensions are only loaded when the host app is properly code-signed. Unsigned release builds can still open files, but Finder may fallback to plain text preview.\nFor local development, open the Xcode project and set a team in `Signing \u0026 Capabilities` for `MDViewerApp` and `MDViewerQuickLookExtension`.\n\nIf Finder still shows plain text preview, refresh Quick Look services:\n\n```bash\nqlmanage -r\nqlmanage -r cache\nkillall Finder\npluginkit -m -A -D -p com.apple.quicklook.preview | grep com.newuni.mdviewer.quicklook\n```\n\n## Open source\n\n- License: MIT\n- Contributions: see `CONTRIBUTING.md`\n- Security policy: see `SECURITY.md`\n\n## Roadmap\n\nSee `ROADMAP.md`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewuni%2Fmd-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnewuni%2Fmd-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewuni%2Fmd-viewer/lists"}