https://github.com/ckt1031/obsidian-wordwise-plugin

Writing companion for AI content generation.
https://github.com/ckt1031/obsidian-wordwise-plugin

chatgpt gpt gpt-3 gpt-4 obsidian obsidian-md obsidian-plugin obsidian-vault openai openai-api

Last synced: 2 months ago
JSON representation

Writing companion for AI content generation.

• Host: GitHub
• URL: https://github.com/ckt1031/obsidian-wordwise-plugin
• Owner: ckt1031
• License: mit
• Created: 2023-06-24T07:08:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-13T14:03:29.000Z (8 months ago)
• Last Synced: 2024-04-13T20:46:31.420Z (8 months ago)
• Topics: chatgpt, gpt, gpt-3, gpt-4, obsidian, obsidian-md, obsidian-plugin, obsidian-vault, openai, openai-api
• Language: TypeScript
• Homepage:
• Size: 1.22 MB
• Stars: 12
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian AI Wordwise

Welcome to **Obsidian WordWise**, a community project adding AI features into Obsidian to simplify your workflow. This plugin integrates prompts, tools and commands powered by AI to boost productivity and enhance user experience.

Guidelines to create and use file-based prompts in WordWise: [Docs](docs/file-prompts.md).

## Supported Providers

- [OpenAI](https://openai.com/) - Advanced and powerful.

- [Google Gemini](https://ai.google.dev/) - Free and performs well in most tasks.

- [Anthropic](https://www.anthropic.com/) - Specializes in generating neutral text.

- [OpenRouter](https://openrouter.ai/) - Integrates AI models with OpenAI and other open-source models.

- [PerplexityAI](https://perplexity.ai/) - Offers online models and fine-tuned LLaMA models.

- [Cohere](https://cohere.com/) - Offers advanced AI models for text generation and comprehension.

## Commands

The plugin provides the following commands:

- **Improve Writing**: Improve your writing such as grammar, sentence structure, and word choice.

- **Fix Grammar**: Fix grammar mistakes in your text.

- **Make Shorter**: Condense your text while retaining the main points, ideal for creating summaries.

- **Make Longer**: Expand on your text to provide more detail or explanation.

- **Highlight Main Point**: Highlight the only main idea in your text.

- **Paraphrase**: Rewrite your text in a different way while keeping the same meaning, perfect for avoiding repetition or enhancing understanding.

- **Simplify Text**: Simplify your text to make it easier to read.

- **Custom Instructions**: Provide custom instructions to the AI to generate specific content.

## Installation

### Community Plugins

1. Open Obsidian and go to Settings > Community Plugins.

2. Install the plugin [here](https://obsidian.md/plugins?id=wordwise).

### BRAT Installation (Beta)

1. Install [BRAT](https://github.com/TfTHacker/obsidian42-brat).

2. Enter the plugin url `https://github.com/ckt1031/obsidian-wordwise-plugin` in the BRAT settings.

3. Enable the plugin and enjoy!

### Manual Installation

You can manually install the Obsidian Wordwise Plugin:

1. Download 3 files - `main.js`, `manifest.json`, and `styles.css` - from the [latest release](https://github.com/ckt1031/obsidian-wordwise-plugin/releases/latest).

2. Create a folder named "wordwise" in your Obsidian vault's plugins folder.

3. Activate the plugin by toggling on its switch under Settings > Community Plugins.

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.