Documentation-Wizard

Active Link: https://syntaxwarrior30.github.io/Documentation-Wizard/

Introduction
This is a documentation generator that utilizes Vite + React, Tailwind CSS and ChatGPT 3.5 Turbo API.
This documentation generator is designed to provide an efficient and user-friendly experience for
developers who need to generate documentation for their programming projects.

Features
Generates high-quality documentation for programming projects.
Ability to detect the current programming language being inputed.
Ability to download or copy the generated documentation.
Utilizes Vite and React for a modern, fast, and responsive user interface.
Uses ChatGPT 3.5 Turbo for intelligent and natural language generation.

Run Locally
Clone the project

  git clone https://github.com/SyntaxWarrior30/Documentation-Wizard

Go to the project directory

  cd Documentation-Wizard

Install dependencies

  npm install

Rename .env.exmaple to .env and input your OpenAI API Key in the format shown below.

VITE_API_KEY={Your OpenAI API Key}

Run the development server

  npm run dev