/writer

🤖📝 A markdown editor powered by AI (Ollama)

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Markdown Editor with LLM Integration

Overview

The Markdown Editor with LLM (Large Language Model) Integration is an open-source project that combines the power of a Markdown editor with the natural language processing capabilities of LLM. This project aims to provide a seamless writing experience for users who want to create Markdown documents while also having the ability to interact with LLM for assistance, suggestions, and more.

Features

  • Markdown Editing: A user-friendly Markdown editor with syntax highlighting and preview functionality.

  • LLM Integration: Seamlessly integrate LLM into the editor to provide real-time suggestions, generate content, and answer questions.

  • Syntax Highlighting: Highlight Markdown syntax for improved readability and editing.

  • Live Preview: Instantly see how your Markdown content will render in real-time.

  • Customizable: Tailor the editor to your needs with customizable themes, keybindings, and extensions.

  • Export Options: Export Markdown documents to various formats such as HTML, PDF, and more.

  • Collaboration: Enable collaborative editing and chat with multiple users through LLM.

  • Version Control: Integrate with Git or other version control systems for easy document management.

Installation

To install the Markdown Editor with LLM Integration, follow these steps:

  1. Clone the GitHub repository:

    git clone https://github.com/intellicode/writer.git

  2. Navigate to the project directory:

    cd markdown-editor

  3. Install the required dependencies:

    npm install

  4. Start the application:

    npm start

Usage

  1. Open the Markdown Editor application.

  2. Create a new document or open an existing one.

  3. Start typing in Markdown, and you'll see real-time syntax highlighting and a live preview of your document.

  4. To interact with LLM, click the LLM integration button or use a keyboard shortcut.

  5. Ask questions, seek suggestions, or request assistance from LLM while writing your document.

  6. Enjoy a seamless writing experience with AI-powered assistance!

Configuration

You can configure various aspects of the Markdown Editor and LLM integration:

  • Themes: Change the editor's theme to suit your preferences.

  • Keybindings: Customize keyboard shortcuts for LLM commands.

  • LLM API Settings: Set your LLM API key and configure LLM behavior.

  • Extensions: Install and manage extensions to enhance functionality.

Contribution

We welcome contributions from the open-source community to make this Markdown Editor even better. If you'd like to contribute, please follow these steps:

  1. Fork the repository.

  2. Create a new branch for your feature or bugfix: git checkout -b feat/name.

  3. Make your changes and commit them: git commit -m 'feat: add feature-name'.

  4. Push to your fork: git push origin feature-name.

  5. Create a pull request on the main repository.

License

This Markdown Editor with LLM Integration is licensed under the GPL v3.0 License. See the LICENSE file for details.

Contact

If you have any questions, suggestions, or issues, please feel free to contact us:

Acknowledgments

We would like to express our gratitude to the open-source community for their contributions and support in making this project possible.

Thank you for using the Markdown Editor with LLM Integration. We hope it enhances your writing experience and productivity. Happy Markdown editing!