obsidian-plugin/markahesketh_write-good-obsidian
1
0
Fork 0
mirror of https://github.com/markahesketh/write-good-obsidian.git synced 2026-07-22 12:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
30 commits 1 branch 6 tags 205 KiB
TypeScript 82%
JavaScript 13.8%
Shell 2.5%
CSS 1.7%
Find a file
Mark Hesketh 94637d2e50 chore: Bump to 1.2.1
2025-06-16 19:39:55 +01:00
.github chore: Instruct copilot to not write tests (yet) and keep all code within main.ts (for now) 2025-06-16 14:19:00 +01:00
bin Initial commit 2025-02-14 21:04:19 +00:00
.editorconfig Initial commit 2025-02-14 21:04:19 +00:00
.eslintignore Initial commit 2025-02-14 21:04:19 +00:00
.eslintrc Initial commit 2025-02-14 21:04:19 +00:00
.gitignore Initial commit 2025-02-14 21:04:19 +00:00
.npmrc Initial commit 2025-02-14 21:04:19 +00:00
esbuild.config.mjs Initial commit 2025-02-14 21:04:19 +00:00
example.png Update readme 2025-02-18 23:08:18 +00:00
LICENSE Update readme 2025-02-18 23:08:18 +00:00
main.ts chore: Re-write settings and readme features to be more clear 2025-06-16 19:38:50 +01:00
manifest.json chore: Bump to 1.2.1 2025-06-16 19:39:55 +01:00
package-lock.json chore: Bump to 1.2.1 2025-06-16 19:39:55 +01:00
package.json chore: Bump to 1.2.1 2025-06-16 19:39:55 +01:00
README.md chore: Re-write settings and readme features to be more clear 2025-06-16 19:38:50 +01:00
styles.css Fixes error when line has multiple errors 2025-02-16 23:52:59 +00:00
tsconfig.json Fixes error when line has multiple errors 2025-02-16 23:52:59 +00:00
version-bump.mjs Initial commit 2025-02-14 21:04:19 +00:00
versions.json chore: Bump to 1.2.1 2025-06-16 19:39:55 +01:00

README.md

Write Good

An Obsidian plugin that integrates write good, a linter for English prose and improving writing style.

Example

Features

  • Identifies common writing issues in your notes
  • Offers suggestions to improve clarity and style, including:
    • Passive voice: Highlights use of passive voice
    • Lexical illusions: Detects repeated words
    • Sentence starts with "So": Flags sentences that start with "So"
    • Sentence starts with "There is/are": Flags sentences that start with "There is" or "There are"
    • Weasel words: Detects words like "many", "various", "very"
    • Adverbs: Highlights adverbs (words ending in -ly)
    • Wordy phrases: Flags wordy phrases that can be simplified
    • Clichés: Detects cliches
    • E-Prime: Flags use of "to be" verbs (E-Prime style)
  • Toggle checks per note via the command palette or a custom hotkey

Settings

  • Enabled by default: Automatically check newly created or opened notes
  • Configurable checks: Turn individual checks on or off (e.g., passive voice, adverbs, etc.)

Installation

From Obsidian Community Plugins

  1. Open Obsidian Settings
  2. Go to Community Plugins and turn off Safe Mode
  3. Click Browse and search for "Write Good"
  4. Install the plugin
  5. Enable the plugin in your Community Plugins settings

Manual Installation

  1. Navigate to the latest release from the Releases page
  2. Download main.js, manifest.json, and style.css from the latest release
  3. Move these files into your Obsidian vault's .obsidian/plugins/write-good/ directory
  4. Reload Obsidian
  5. Enable the plugin in your Community Plugins settings

Usage

  1. Open any note in your vault
  2. Writing suggestions will automatically appear as you type

Development

  1. Clone this repository to your machine
  2. Run bin/npm install to install dependencies
  3. Run bin/npm run dev to start compilation in watch mode
  4. Copy or symlink the repository to your Obsidian vault's plugins folder: .obsidian/plugins/write-good-obsidian/

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/markahesketh/write-good-obsidian.

License

This plugin is available as open source under the terms of the MIT License.