Skip to content

artificialguybr/obsidian-note-generator

Repository files navigation

Obsidian Note Generator

An AI-powered note generator plugin for Obsidian that helps you create interconnected notes through an intuitive chat interface. This plugin leverages artificial intelligence to help you generate, organize, and connect your notes seamlessly within your Obsidian vault.

Features

  • 🤖 Dual Mode Operation:
    • Chat Mode: Have natural conversations with AI to explore ideas and get answers about your notes.
    • Note Generation Mode: Directly create structured notes with AI assistanc.e
  • 🔗 Automatic Note Linking: Intelligently creates wiki-links to connect your new notes with existing ones
  • 📝 Smart Note Generation: Creates well-structured notes based on your conversations or direct prompts
  • 🎨 Modern UI: Clean and intuitive interface that matches Obsidian's design
  • 🌙 Theme Compatible: Works seamlessly with both light and dark themes
  • 🔍 Context-Aware: Understands and references your existing notes for better content generation

Installation

  1. Open Obsidian Settings
  2. Go to Community Plugins and disable Safe Mode
  3. Click Browse and search for "Note Generator"
  4. Install the plugin and enable it
  5. Configure your API key in the plugin settings

Usage

Chat Mode

  1. Click the chat icon in the ribbon (sidebar) or use the command palette
  2. Select "Chat Mode" from the mode switcher
  3. Have natural conversations with the AI assistant
  4. Get answers, brainstorm ideas, and explore concepts

Note Generation Mode

  1. Click the chat icon or use the command palette
  2. Select "Note Generation Mode" from the mode switcher
  3. Describe the note you want to create
  4. The AI will generate a structured note based on your requirements
  5. Review and edit the generated note before saving

Features in Both Modes

  • Smart Context: The AI understands your existing notes for better responses
  • Wiki-linking: Automatic creation of relevant connections to existing notes
  • History: Access your previous conversations and generations
  • Copy & Export: Easy options to copy content or export to new notes

Configuration

Required Settings

  • API Key: Enter your API key in the plugin settings from Gemini AI!

Development

Prerequisites

  • Node.js 16+
  • npm or yarn
  • Obsidian development environment

Local Development

  1. Clone the repository
git clone https://github.com/ArtificialguyBR/obsidian-note-generator.git
  1. Install dependencies
npm install
  1. Build the plugin
npm run build
  1. Copy or symlink the plugin to your Obsidian vault's plugins folder

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions:

Credits

Created with ❤️ by ArtificialguyBR


If you find this plugin helpful, consider:

  • ⭐ Starring the repository
  • 💡 Contributing ideas and feedback
  • 🐛 Reporting bugs
  • 📖 Improving documentation

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published