{"id":28495255,"url":"https://github.com/markedit-app/markedit-preview","last_synced_at":"2026-05-04T03:03:20.928Z","repository":{"id":296847421,"uuid":"990008977","full_name":"MarkEdit-app/MarkEdit-preview","owner":"MarkEdit-app","description":"Markdown preview for MarkEdit.","archived":false,"fork":false,"pushed_at":"2026-04-29T14:18:03.000Z","size":8794,"stargazers_count":179,"open_issues_count":2,"forks_count":10,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-04-29T16:19:27.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/MarkEdit-app.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":null,"dco":null,"cla":null}},"created_at":"2025-05-25T10:06:49.000Z","updated_at":"2026-04-29T14:20:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"227f139e-bfa7-4233-bffc-3bcc1f19d30d","html_url":"https://github.com/MarkEdit-app/MarkEdit-preview","commit_stats":null,"previous_names":["markedit-app/markedit-preview"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/MarkEdit-app/MarkEdit-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkEdit-app%2FMarkEdit-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkEdit-app%2FMarkEdit-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkEdit-app%2FMarkEdit-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkEdit-app%2FMarkEdit-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MarkEdit-app","download_url":"https://codeload.github.com/MarkEdit-app/MarkEdit-preview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarkEdit-app%2FMarkEdit-preview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32592720,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T22:12:39.696Z","status":"online","status_checked_at":"2026-05-04T02:00:06.625Z","response_time":58,"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":[],"created_at":"2025-06-08T11:08:30.061Z","updated_at":"2026-05-04T03:03:20.922Z","avatar_url":"https://github.com/MarkEdit-app.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkEdit-preview\n\nMarkdown preview for MarkEdit that leverages [markedit-api](https://github.com/MarkEdit-app/MarkEdit-api).\n\n## Installation\n\nCopy [dist/markedit-preview.js](dist/markedit-preview.js?raw=true) to `~/Library/Containers/app.cyan.markedit/Data/Documents/scripts/`. Details [here](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization#entries).\n\nUse [dist/lite/markedit-preview.js](dist/lite/markedit-preview.js?raw=true) if you don't need [mermaid](https://mermaid.js.org/), [katex](https://katex.org/) and [highlight.js](https://highlightjs.org/); it's much smaller (about 200 KB, compared to about 4 MB for the full build).\n\n\u003e Once installed, restart MarkEdit to apply the changes.\n\u003e\n\u003e This extension automatically checks for updates and notifies you when a new version is available.\n\n## Building\n\nRun `yarn install \u0026\u0026 yarn build` to build and deploy the script.\n\nTo build the lite version, run `yarn build:lite` instead.\n\n## Development\n\n- `yarn test` — run tests\n- `yarn lint` — run linting (also runs automatically before build)\n\n## How to Use\n\nAccess it from the `Extensions` menu in the menu bar, or use the keyboard shortcut \u003ckbd\u003eShift–Command–V\u003c/kbd\u003e.\n\n\u003cimg src=\"./screenshot.png\" width=\"520\" alt=\"Using MarkEdit-preview\"\u003e\n\nTo display local images, please ensure you're using MarkEdit 1.24.0 or later and follow [the guide](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization#grant-folder-access) to grant file access.\n\nThis extension also exposes a global function, `MarkEditGetHtml(styled: boolean) =\u003e Promise\u003cstring\u003e`, allowing other extensions or scripts to easily generate the rendered HTML.\n\n## Styling\n\nThis extension applies the [github-markdown](https://github.com/sindresorhus/github-markdown-css) styling. You can customize the appearance by following the [customization](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization) guidelines.\n\nThe preview pane can be styled using the `markdown-body` CSS class.\n\n## Settings\n\nIn [settings.json](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization#advanced-settings), you can define a settings node named `extension.markeditPreview` to configure this extension, default settings are:\n\n```json\n{\n  \"extension.markeditPreview\": {\n    \"updateBehavior\": \"quiet\",\n    \"syncScroll\": true,\n    \"hidePreviewButtons\": true,\n    \"syntaxAutoDetect\": false,\n    \"imageHoverPreview\": false,\n    \"themeName\": \"github\",\n    \"styledHtmlColorScheme\": \"auto\",\n    \"mathDelimiters\": [],\n    \"changeMode\": {\n      \"modes\": [\"side-by-side\", \"preview\"],\n      \"hotKey\": {\n        \"key\": \"V\",\n        \"modifiers\": [\"Command\"]\n      }\n    },\n    \"markdownIt\": {\n      \"preset\": \"default\",\n      \"options\": {}\n    }\n  }\n}\n```\n\n- `updateBehavior`: `\"quiet\"` shows a button, `\"notify\"` shows an alert, `\"never\"` disables update checks.\n- `syncScroll`: Whether to enable scroll synchronization.\n- `hidePreviewButtons`: Whether to hide the built-in preview buttons in side-by-side mode (not applicable for lite build).\n- `syntaxAutoDetect`: Whether to enable automatic language detection for syntax highlighting in code blocks (not applicable for lite build).\n- `imageHoverPreview`: Whether to enable image preview on hover.\n- `themeName`: Set the preview color theme, available themes can be found in the [`styles/themes`](styles/themes) folder.\n- `styledHtmlColorScheme`: Determine the color scheme of saving styled html files, valid values are `light`, `dark`, and `auto`.\n- `mathDelimiters`: Customize math delimiters for KaTeX rendering (not applicable for lite build), each delimiter object has `left`, `right`, and `display` properties, defaults to `$...$`, `$$...$$`, `\\(...\\)`, and `\\[...\\]`.\n- `changeMode.modes`: Define available preview modes for the \"Change Mode\" feature.\n- `changeMode.hotKey`: Assign keyboard shortcuts for mode switching. See the specification [here](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization#generalmainwindowhotkey).\n- `markdownIt.preset`: Override the default [markdown-it](https://markdown-it.github.io/markdown-it/#MarkdownIt.new) preset.\n- `markdownIt.options`: Customize [markdown-it](https://markdown-it.github.io/markdown-it/#MarkdownIt.new) options.\n\n\u003e Extension settings require MarkEdit 1.24.0 or later.\n\n## Contribution\n\nPull requests are welcome, but please discuss the proposal before making changes. This helps avoid misunderstandings and saves effort on both sides.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkedit-app%2Fmarkedit-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkedit-app%2Fmarkedit-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkedit-app%2Fmarkedit-preview/lists"}