Skip to content

This tool is a desktop application that allows users to convert exported ChatGPT-style chat conversations (in JSON format) into cleanly formatted Markdown files.

Notifications You must be signed in to change notification settings

germabyte/chat2markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

📄 JSON to Markdown Chat Converter

1. Introduction and Purpose

🔍 Introduction

This tool is a desktop application that allows users to convert exported ChatGPT-style chat conversations (in JSON format) into cleanly formatted Markdown files.

🎯 Purpose & Problem Statement

OpenAI's ChatGPT conversations, when exported, are stored in nested JSON files that are difficult to read or repurpose. This program extracts the meaningful messages from those JSON files and outputs them in a simple, readable Markdown format suitable for archiving, sharing, or publishing.

✅ Value Proposition

  • Quickly converts complex, nested JSON chat logs into readable Markdown documents.
  • Clean and user-friendly graphical interface — no coding knowledge required.
  • Great for documenting conversations, note-taking, publishing Q&A, and archiving AI interactions.

2. Dependencies (Required Software/Libraries)

This program is written in Python and uses built-in libraries only. No additional installations are needed beyond a standard Python setup.

Dependency Description
tkinter Powers the graphical user interface (buttons, file selection). Comes pre-installed with Python.
json Handles reading and parsing of the exported JSON chat file. Built-in.
os Helps manage file paths and file I/O. Built-in.

✅ Installation Instructions:

  1. Install Python (if not already installed)

  2. Verify installation
    Open a terminal or command prompt and type:

    python --version
  3. No additional libraries required
    All libraries used are included in the standard Python installation.


3. Getting Started (Installation & Execution)

📥 Download the Repository:

  1. Visit the GitHub repository page.
  2. Click the green "<> Code" button.
  3. Choose "Download ZIP".
  4. Extract the ZIP file to a location of your choice.

▶️ Run the Program:

  1. Open a terminal (or command prompt).
    • Windows: Press Win + R, type cmd, and press Enter.
    • Mac/Linux: Use your system’s Terminal app.
  2. Navigate to the folder where you extracted the script:
    cd path/to/extracted/folder
  3. Run the Python script:
    python chat2markdown.py

The application window will open automatically.


4. User Guide (How to Effectively Use the Program)

👣 Step-by-Step Instructions:

  1. Launch the App
    A simple GUI window will appear titled “JSON to Markdown Converter”.

  2. Select Input File

    • Click the “Browse” button next to Select JSON File.
    • Choose your exported ChatGPT-style JSON conversation file.
  3. Choose Output Location

    • Click the “Browse” button next to Save Markdown As.
    • Choose where to save the Markdown file and what to name it (e.g., chat_output.md).
  4. Click Convert

    • Press the Convert button.
    • A success message will appear once conversion is complete.

📥 Input Format:

  • The program expects a ChatGPT-style JSON structure that includes:
    • A top-level list
    • A mapping key with messages containing message, author, content, parts, and create_time.

📤 Output Format:

  • A .md (Markdown) file with:
    • User messages displayed in blockquote format.
    • Assistant responses shown in code blocks.
    • Clean formatting with horizontal rules between each exchange.

⚙️ Configuration:

  • No configuration files or command-line arguments required.
  • All interactions are performed through the GUI.

5. Use Cases and Real-World Examples

✅ Example 1: Saving AI-assisted notes for a project

Situation: A user chats with ChatGPT about how to design a resume.
Action: They export the conversation JSON and run this tool.
Result: A Markdown version is saved and used in their documentation or Notion page.


✅ Example 2: Archiving chatbot Q&A for customer support

Situation: A support team uses ChatGPT to answer common customer questions.
Action: After collecting chats, they convert them to Markdown.
Result: Easy-to-read internal documentation of Q&A interactions.


✅ Example 3: Publishing ChatGPT tutorials or guides

Situation: A blogger wants to publish a guide showing a ChatGPT-generated solution.
Action: They convert the exported JSON and paste the Markdown directly into a blog post.
Result: Clean formatting and consistent presentation of the chat.


6. Disclaimer & Important Notices

  • The contents of this repository may change at any time without prior notice.
  • Future updates may render parts of this README file obsolete.
  • This software is provided “as-is”, with no guarantees regarding performance, compatibility, or correctness.
  • The developer makes no commitment to maintain, support, or update this codebase.

About

This tool is a desktop application that allows users to convert exported ChatGPT-style chat conversations (in JSON format) into cleanly formatted Markdown files.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages