strikemd
v0.1.5
Published
AI-powered suggestion-mode editor for markdown. Run editorial checks and review changes Google Docs-style in the browser.
Maintainers
Readme
strikemd
AI-powered suggestion mode for markdown files. Run editorial checks and review changes Google Docs-style in the browser.
Features
- 🔍 AI editorial checks — run prose checks like "remove redundancy", "hedge strong claims", "clarify unclear sentences" against any markdown file
- 📝 Inline suggestions — see deletions, insertions, and replacements rendered inline with your document
- ✅ Accept/reject — review each suggestion
- 💬 Reviewer comments — every suggestion includes an explanation of why the change improves the text
- 🔧 Custom checks — run
strikemd initto customize which checks you use - 💾 Save in place — accepted changes write back to the original file
Install
Requires Bun.
bun install -g strikemdUsage
strikemd my-essay.mdThis opens a browser UI where you pick a check and model, run it, and review the suggestions.
Pass an API key with --key, the ANTHROPIC_API_KEY env var, or a .env file.
strikemd my-essay.md --key sk-ant-...Other commands:
strikemd help # show usage info
strikemd init # create .strikemd/checks.md with default checks
strikemd -v # print versionBuilt-in checks
- Remove redundant sentences — cut sentences that repeat a point or add no new information
- Hedge too-strong claims — qualify assertions that are stated too strongly
- Replace rhetoric with substance — swap emotional appeals for concrete statements
- Activate passive voice — rewrite passive constructions in active voice where it helps
- Clarify unclear sentences — rewrite ambiguous or hard-to-parse sentences
- Make the download explicit — turn abstract explanations into concrete frameworks
Custom checks
Run strikemd init to copy the default checks into .strikemd/checks.md. Edit that file to add, remove, or rewrite checks. Each # Heading becomes a check name, and the body becomes the prompt:
# Fix jargon
Find technical jargon that could be replaced with plain language. Rewrite for a general audience.
# Shorten paragraphs
Break paragraphs longer than 4 sentences into smaller ones.When .strikemd/checks.md exists, it replaces the built-in checks entirely.
License
MIT
