A collaborative AI tool for generating documentation content from markdown files, using hidden comments as input.

Processes markdown files with embedded comments, allowing for faster and more efficient documentation creation.

• Speeds up documentation creation
• Utilizes AI-powered generation capabilities
• Supports markdown file format

Writing documentation takes significantly longer than reading it.

Aim to benefit the reader, not just the writer, by leveraging AI to automate documentation creation, bridging the efficiency gap.

Non-native English writers struggle with language accuracy, further slowing down documentation creation.

Provides AI-powered language assistance to ensure accurate and polished content, enabling smoother documentation creation.

• Leverage Markdown: Build upon the existing markdown format, making it easy to integrate and maintain.
• Human-LLM Interface: Create a seamless interaction between humans and LLMs, enabling writers to provide context and guidance.

Enhance markdown files with hidden comments that serve as input for the LLM.

# Ghost LLM - A Collaborative AI Tool for Documentation Generation

## Problem Statement
Writing documentation takes significantly longer than reading it.

## Solution Overview
Aim to benefit the reader, not just the writer, by leveraging AI to automate documentation creation, bridging the efficiency gap.

## Additional Challenge
Non-native English writers struggle with language accuracy, further slowing down documentation creation.

## How It Works
Leverage Markdown, enhance it with human-LLM interface in order to generate text. Build upon existing format, make easy to integrate and maintain.

## Core Functionality
Enhance markdown files with hidden comments that serve as input for LLM.

Note: This README file is a prime example of how Ghost LLM can be used to create documentation content directly within the Markdown file itself!

1. Install Ollama: Follow the instructions on the official website (https://ollama.com/) to set up the LLM model.
2. Integrate with Markdown: Enhance markdown files by adding hidden comments that serve as input for Ollama, enabling AI-powered content generation.

• Specify the Model: Use a command like #model <model_name:version> to select the desired LLM model.
• Example Usage: Include the model specification directly within the markdown file, e.g., #model llama:1.3

#system
You are a professional technical writer.
Don't write out instructions or explanations.
Instead, provide concise and to-the-point answers.
Format your response in Markdown, keeping it brief and clear.

• Example Response: Use this system message as a reminder to keep responses concise, formatted in Markdown, and focused on the essential information.

• Request Content: Simply add #chat message to initiate a conversation with Ollama.
• Example Usage: Use this command directly within the markdown file, followed by your message, e.g., #chat What is Ghost LLM?.

• #conversation : Start a new conversation context.
• #context : Embed external files into the current conversation context.
• #seed : Set a fixed seed value to ensure reproducibility across conversations.

You can run ghost_llm.py from the command line using the following options:

• src: The source directory containing Markdown files.

• -r, --recursive: Recursively search for Markdown files in the specified source directory.
• --dry-run: Run without making changes to existing Markdown files.
• -w, --watch: Watch the specified source directory for changes and re-process Markdown files as needed.
• --ollama: URL of Ollama server to use.

python ghost_llm.py /path/to/markdown/files --recursive

python ghost_llm.py /path/to/markdown/files --recursive --dry-run

python ghost_llm.py /path/to/markdown/files -r

python ghost_llm.py /path/to/markdown/files --ollama https://example.com/ollama

To highlight the key benefits of ghost_llm.py, here's a summary:

Ghost LLM: Offline Markdown Processing

• Offline operation: Process Markdown files without any internet connection required.
• Local processing: All text processing happens on your local machine, ensuring complete control and security over your data.
• Plane-friendly: Work with Markdown files anywhere, anytime, even in areas with no internet access.

These benefits make ghost_llm.py an ideal choice for:

• Writers and authors who want to focus on their craft without worrying about internet connectivity.
• Researchers and students who need to work with large datasets or sensitive information offline.
• Anyone who values the security and convenience of local data processing.

Generated by: ghost-writer-llm