lucasmelin/red-pen

A proofreader for your writing. 🖊️

Red Pen

Red Pen acts as a proofreader for your writing.
It highlights phrases that could use simplifying, identifies weasel words, hedges, filler, and many more.


Red Pen is implemented as a retext-based plugin for the Obsidian note-taking app.

Development

This project uses TypeScript to provide type checking and documentation. The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.

NodeJS instructions

Install NodeJS.

Navigate to the plugin directory.

cd red-pen

Install the project dependencies.

npm install

Compile the source code. The following command keeps running in the terminal and rebuilds the plugin when you modify the source code.

npm run dev

Nix instructions

Install Nix as well as direnv.

Navigate to the plugin directory.

cd red-pen

Run nix build to compile the plugin.

The resulting main.js, styles.css, and manifest.json can then be found in the ./result/lib/node_modules/red-pen directory.

Manually installing the plugin

Copy over main.js, styles.css, manifest.json to your Obsidian Vault <VaultFolder>/.obsidian/plugins/red-pen/.