https://github.com/lucasmelin/red-pen

A proofreader for your writing. 🖊️
https://github.com/lucasmelin/red-pen

obsidian-md obsidian-plugin plugin

Last synced: 12 days ago
JSON representation

A proofreader for your writing. 🖊️

• Host: GitHub
• URL: https://github.com/lucasmelin/red-pen
• Owner: lucasmelin
• License: mit
• Created: 2023-07-30T17:14:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-31T20:45:21.000Z (over 1 year ago)
• Last Synced: 2024-10-03T09:58:08.334Z (3 months ago)
• Topics: obsidian-md, obsidian-plugin, plugin
• Language: TypeScript
• Homepage:
• Size: 70.3 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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](https://nodejs.org/en).

Navigate to the plugin directory.

```bash

cd red-pen

```

Install the project dependencies.

```bash

npm install

```

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

```bash

npm run dev

```

### Nix instructions

[Install Nix](https://github.com/DeterminateSystems/nix-installer) as well as [`direnv`](https://direnv.net/).

Navigate to the plugin directory.

```bash

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`](./result/lib/node_modules/red-pen) directory.

## Manually installing the plugin

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