Skip to content

A user-friendly tool that converts ChatGPT conversation exports from JSON format to easy-to-read 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

3 Commits
 
 
 
 
 
 

Repository files navigation

chat2markdown

A user-friendly tool that converts ChatGPT conversation exports from JSON format to easy-to-read Markdown files.

What Does It Do?

chat2markdown transforms ChatGPT conversation exports into readable Markdown documents. It preserves the natural flow of the conversation while making it easier to read and share. The tool features:

  • A simple graphical interface for selecting files
  • Clear visual distinction between user and ChatGPT messages
  • Automatic conversation ordering based on timestamps
  • Support for UTF-8 encoding to handle special characters
  • Error handling with helpful messages

Getting Started

Prerequisites

  • Python installed on your computer
  • The chat2markdown.py script
  • ChatGPT conversation exports in JSON format

Installation

  1. Download the repository files:

    • Click the green "Code" button at the top of this page
    • Select "Download ZIP"
    • Extract the ZIP file to your preferred location
  2. Run the program:

    • Navigate to the extracted folder
    • Double-click chat2markdown.py to launch the application
    • If double-clicking doesn't work, open your terminal/command prompt in the extracted folder and type: python chat2markdown.py

How to Use

  1. Select Input File:

    • Click "Browse" next to "Select JSON File"
    • Choose your ChatGPT conversation export (JSON file)
  2. Choose Output Location:

    • Click "Browse" next to "Save Markdown As"
    • Select where you want to save the converted file
    • Make sure to add ".md" at the end of the filename
  3. Convert:

    • Click the green "Convert" button
    • Wait for the success message

Use Cases

Sharing Conversations

Perfect for when you need to share ChatGPT conversations with others in a readable format, such as:

  • Teaching materials
  • Technical discussions
  • Problem-solving sessions
  • Tutorial walkthroughs

Documentation

Useful for creating documentation from ChatGPT conversations about:

  • Code explanations
  • Troubleshooting steps
  • Learning resources
  • Project discussions

Repository Status Notice

This repository may be updated at any time. While efforts are made to keep documentation current, the README might not always reflect the latest changes to the repository.

Troubleshooting

If you encounter issues:

  • Ensure your JSON file is a valid ChatGPT conversation export
  • Check that you have sufficient permissions to read/write in the selected folders
  • Verify that the JSON file isn't empty or corrupted
  • Make sure you're using the latest version of the script

The program will display specific error messages to help identify and resolve any issues that occur during conversion.

About

A user-friendly tool that converts ChatGPT conversation exports from JSON format to easy-to-read Markdown files.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages