Red Pen

by Lucas Melin
5
4
3
2
1
Score:Β 34/100

Description

The Red Pen plugin for Obsidian serves as an advanced writing proofreader. It identifies and highlights areas that could be simplified, such as weasel words, hedges, fillers, and other linguistic nuances that weaken writing clarity. The plugin is built on the retext framework and helps users improve the quality of their written content within Obsidian, making it ideal for writers, researchers, and note-takers who want to refine their language and communication. By pinpointing problematic phrases, Red Pen assists in making writing more concise and impactful.

Reviews

No reviews yet.

Stats

10
stars
5,583
downloads
0
forks
988
days
1,013
days
1,013
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
1
total issues
1
open issues
0
closed issues
0
commits

Latest Version

3 years ago

Changelog

Fix sentence casing in the settings UI.

Full Changelog: https://github.com/lucasmelin/red-pen/compare/1.0.0...1.0.1

README file from

Github

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/.