https://github.com/markedit-app/markedit-ai-writer
AI writer for MarkEdit, based on Apple's Foundation Models.
https://github.com/markedit-app/markedit-ai-writer
Last synced: 8 months ago
JSON representation
AI writer for MarkEdit, based on Apple's Foundation Models.
- Host: GitHub
- URL: https://github.com/markedit-app/markedit-ai-writer
- Owner: MarkEdit-app
- License: mit
- Created: 2025-09-27T06:38:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-20T06:39:28.000Z (8 months ago)
- Last Synced: 2025-10-20T08:58:26.737Z (8 months ago)
- Language: TypeScript
- Size: 305 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MarkEdit-ai-writer
AI writer for MarkEdit that leverages [markedit-api](https://github.com/MarkEdit-app/MarkEdit-api), based on Apple's [Foundation Models](https://developer.apple.com/documentation/FoundationModels).
You can invoke it from the menu bar, with the keyboard shortcut Option–Command–/, or via the tooltip.
## Installation
Copy [dist/markedit-ai-writer.js](dist/markedit-ai-writer.js?raw=true) to `~/Library/Containers/app.cyan.markedit/Data/Documents/scripts/`.
You can also run `yarn install && yarn build` to build and deploy the script.
## Settings
In [settings.json](https://github.com/MarkEdit-app/MarkEdit/wiki/Customization#advanced-settings), you can define a settings node named `extension.markeditAIWriter` to configure this extension, default settings are:
```json
{
"extension.markeditAIWriter": {
"keyboardShortcut": "Mod-Alt-/",
"showsTooltip": true,
"streaming": false,
"instructions": "You are a writing assistant specialized in rewriting text. Always return only the rewritten or improved version of the input while strictly preserving any Markdown formatting (including headings, lists, links, and inline styles). Do not add explanations, instructions, or commentary—output only the content itself.",
"generationOptions": {},
"customWriters": []
}
}
```
- `keyboardShortcut`: The keyboard shortcut, see specs [here](https://codemirror.net/docs/ref/#view.KeyBinding).
- `showsTooltip`: Whether to show a tooltip as an entry point.
- `streaming`: Whether to enable output streaming.
- `instructions`: Instructions used to create the language model session.
- `generationOptions`: Generation options to control the output, in `{ temperature?: number; maximumResponseTokens?: number }` format.
- `customWriters`: Pre-defined prompts, see [writers.ts](src/writers.ts) for examples.
> This extension requires MarkEdit 1.27.0 or later and is supported only on macOS Tahoe with Apple Intelligence enabled.