{"id":15723964,"url":"https://github.com/smittytone/previewmarkdown","last_synced_at":"2025-08-21T20:32:08.157Z","repository":{"id":45937529,"uuid":"218737098","full_name":"smittytone/PreviewMarkdown","owner":"smittytone","description":"QuickLook Markdown preview and icon thumbnailing app extensions for macOS Catalina and beyond","archived":false,"fork":false,"pushed_at":"2024-09-30T20:26:42.000Z","size":1669,"stargazers_count":45,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-10T19:24:09.125Z","etag":null,"topics":["extensions","macos","markdown","preview-generator","quicklook","swift","thumbnail-generator"],"latest_commit_sha":null,"homepage":"https://smittytone.net/previewmarkdown/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smittytone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2019-10-31T10:09:02.000Z","updated_at":"2024-12-04T21:14:59.000Z","dependencies_parsed_at":"2023-10-01T17:20:47.562Z","dependency_job_id":"12f81ee4-5819-4f1d-950a-3793be58a8da","html_url":"https://github.com/smittytone/PreviewMarkdown","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smittytone%2FPreviewMarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smittytone%2FPreviewMarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smittytone%2FPreviewMarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smittytone%2FPreviewMarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smittytone","download_url":"https://codeload.github.com/smittytone/PreviewMarkdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230532443,"owners_count":18240792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["extensions","macos","markdown","preview-generator","quicklook","swift","thumbnail-generator"],"created_at":"2024-10-03T22:13:57.312Z","updated_at":"2025-08-21T20:32:08.137Z","avatar_url":"https://github.com/smittytone.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PreviewMarkdown 2.0.0\n\nThis app provides [Markdown](https://daringfireball.net/projects/markdown/syntax) file preview and thumbnailing extensions for versions of macOS 10.15 or above.\n\nVersion 2.0.0 features a brand new rendering engine which adds support for tables, source code highlighting, nested blockquotes and more. It adds preliminary img support\n\n[![PreviewMarkdown App Store QR code](qr-code.jpg)](https://apps.apple.com/gb/app/previewmarkdown/id1492280469)\n\n## Installation and Usage\n\nJust run the host app once to register the extensions \u0026mdash; you can quit the app as soon as it has launched. We recommend logging out of your Mac and back in again at this point. Now you can preview markdown documents using QuickLook (select an icon and hit Space), and Finder’s preview pane and **Info** panels.\n\nYou can disable and re-enable the Previewer and Thumbnailer extensions at any time in **System Preferences \u003e Extensions \u003e Quick Look**.\n\n### Adjusting the Preview\n\nYou can alter some of the key elements of the preview by using the **Preferences** panel:\n\n- The base body font and text size.\n- The monospaced code font.\n- The colour of headlines, code, blockquotes and link text.\n- Whether YAML front matter should be displayed too. This is handy if you are a [Hugo](https://gohugo.io) or [Jekyll](https://jekyllrb.com) user — [see below for more details](#yaml-front-matter).\n- Whether preview should be display white-on-black even in macOS’ Dark Mode.\n\nChanging these settings will affect previews immediately, but may not affect thumbnails until you open a folder that has not been previously opened in the current login session, or you log out of your macOS user account. This is because Finder caches thumbnails generated in a given session.\n\n### YAML Front Matter\n\n*PreviewMarkdown* supports rendering YAML front matter in Markdown files. To enable it, go to **Preview Markdown \u003e Preferences...** and check the **Show YAML front matter** checkbox. YAML will appear in QuickLook previews only, not thumbnails.\n\nYAML front matter can be delimited with both `---` and `---`, and `---` and `...` start and end markers, as per [the YAML 1.2 specification](https://yaml.org).\n\n## Known Issues\n\n1. Tables containing nested remote images may take an extended time to render while `NSAttributedString`’s WebKit-based HTML parser attempts to request the image, which ultimately fails. We are exploring mitigations.\n1. Tables are intermittently rendered with horizontal blanks in place of borders. Resizing the preview window fixes them (though may cause other horizontal lines to disappear). We are exploring mitigations.\n1. Users of Markdown editing tools like OneMarkdown and Marked may not see PreviewMarkdown-produced previews. This is because those apps claim ownership of key Markdown file UTIs which may cause Finder to pre-empt PreviewMarkdown. There is no workaround at this time.\n\n## Source Code\n\nThis repository contains the primary source code for *PreviewMarkdown*. Certain graphical assets, code components and data files are not included. To build *PreviewMarkdown* from scratch, you will need to add these files yourself or remove them from your fork’s Xcode project.\n\nThe files `REPLACE_WITH_YOUR_FUNCTIONS` and `REPLACE_WITH_YOUR_CODES` must be replaced with your own files. The former will contain your `sendFeedback(_ feedback: String) -\u003e URLSessionTask?` function. The latter your Developer Team ID, used as the App Suite identifier prefix.\n\nYou will need to generate your own `Assets.xcassets` file containing the app icon.\n\nYou will need to create your own `new` directory containing your own `new.html` file.\n\n## Acknowledgements\n\nPreviewMarkdown’s app extensions contains [YamlSwift](https://github.com/behrang/YamlSwift) by Behrang Noruzi Niya and other contributors, and [Markdown-It](https://github.com/markdown-it/markdown-it) by Vitaly Puzrin and Alex Kocharin.\n\n## Release Notes\n\nSee [CHANGELOG.md](CHANGELOG.md)\n\n## Copyright and Credits ##\n\nPrimary app code and UI design \u0026copy; 2025, Tony Smith.\n\nCode portions \u0026copy; 2014-25 Vitaly Puzrin, Alex Kocharin; \u0026copy; 2006-25, Josh Goebel and Other Contributors; \u0026copy; 2015 Behrang Noruzi Niya. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmittytone%2Fpreviewmarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmittytone%2Fpreviewmarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmittytone%2Fpreviewmarkdown/lists"}