Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs: rewrote Obsidian page

Elijah Potter6d8bda8a7620
diff --git a/packages/web/src/routes/docs/integrations/obsidian/+page.md b/packages/web/src/routes/docs/integrations/obsidian/+page.md
index 0bfb5d5de..f07f908ab 100644
--- a/packages/web/src/routes/docs/integrations/obsidian/+page.md
+++ b/packages/web/src/routes/docs/integrations/obsidian/+page.md
@@ -1,21 +1,81 @@
---
-title: Obsidian
+title: Harper for Obsidian
---
+The **Harper Plugin** is a powerful, privacy-first grammar and spell-checking tool designed specifically for Obsidian users. Unlike many other grammar checkers, Harper operates entirely offline, ensuring your data remains secure while providing real-time, high-performance corrections. This plugin is ideal for writers, academics, and developers who value privacy and efficiency in their workflows.
+
![A screenshot of Obsidian with Harper installed](/images/obsidian_screenshot.webp)
-[Obsidian](https://obsidian.md/) is a popular Markdown editor and [Zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) knowledge vault.
-Its extensive plugin ecosystem makes it an attractive choice for note-taking students and documenting professionals.
+## **Key Features**
+
+### **1. Privacy-Focused**
+
+- Harper runs **entirely on your device**, meaning no data is sent to external servers.
+- Unlike tools like Grammarly or LanguageTool (when not self-hosted), Harper ensures complete ownership and confidentiality of your notes.
+
+### **2. Real-Time Grammar and Spell Checking**
+
+- The plugin automatically scans your text as you type, highlighting grammatical errors, spelling mistakes, and stylistic inconsistencies.
+- Hovering over an error provides instant suggestions for corrections, making editing seamless.
+
+### **3. Lightweight and Fast**
+
+- Built with performance in mind, Harper delivers corrections in milliseconds without slowing down even large vaults.
+- It has a minimal memory footprint compared to alternatives like LanguageTool, which can require significant resources.
+
+### **4. Open Source**
+
+- Harper is fully open source, allowing transparency and community contributions to improve its functionality.
+- Developers can review the codebase or contribute directly via the [GitHub repository](https://github.com/automattic/harper-obsidian-plugin).
+
+### **5. Simple Installation and Integration**
+
+- Easily install Harper from Obsidian’s Community Plugins section.
+- Works seamlessly with both Live Preview and Reading Mode.
+
+## **How It Compares to Other Plugins**
+
+| Feature | Harper | LanguageTool |
+| ---------------------- | ----------------------------- | --------------------------------- |
+| **Privacy** | 100% offline | Requires self-hosting for privacy |
+| **Real-Time Checking** | Yes | Yes |
+| **Language Support** | American English (extensible) | 30+ languages |
+| **Open Source** | Yes | Partially |
+| **Ease of Use** | Simple setup | Requires API/self-hosting setup |
+| **Performance** | Fast and lightweight | Resource-intensive |
-While one of main features of Obsidian is privacy, a server-side LanguageTool plugin is one of the most popular on the platform.
-Harper aims to replace LanguageTool by being faster, better, and entirely private.
+## **Installation Guide**
+
+1. Open Obsidian and navigate to **Settings → Community Plugins → Browse**.
+2. Search for "Harper" in the plugin library.
+3. Click "Install" and then "Enable."
+4. Start typing in your notes—Harper will automatically highlight errors as you go!
+
+## **Limitations**
+
+- Currently supports only American English, though the system is extensible for other languages with community contributions.
+- Does not include advanced features like style guides or multi-language support found in some competitors.
+
+## **Future Development**
+
+The team behind Harper welcomes feedback and contributions from the community. Planned updates include:
+
+- Support for additional languages.
+- Advanced customization options for grammar rules.
+- Improved performance for extremely large documents.
+
+## **Why Choose Harper?**
+
+Harper stands out as a reliable, private, and efficient grammar checker tailored to Obsidian users' needs. Whether you're drafting essays, documenting code, or simply jotting down ideas, Harper ensures your writing is polished without sacrificing speed or security.
+
+For more details or to contribute to the project, visit the [GitHub page](https://github.com/automattic/harper-obsidian-plugin).
## Installation
+![A screenshot of the Harper Obsidian installation.](/images/obsidian_install_screenshot.webp)
+
To add Harper to [Obsidian](/obsidian), just install the community plugin.
More specifically, go to Obsidian's settings and click "Community Plugins."
You may be asked to enable them.
Next, click "Browse" and search for "Harper".
Finally, go back to the Community Plugins page and enable the plugin.
-
-![A screenshot of the Harper Obsidian installation.](/images/obsidian_install_screenshot.webp)