/Unity2Markdown

Unity2Markdown is a Python-based application that converts Unity documentation HTML files to Markdown format. It provides a simple graphical user interface for easy conversion of single or multiple HTML files.

Primary LanguagePythonMIT LicenseMIT

Unity2Markdown

Unity2Markdown is a Python-based application that converts Unity documentation HTML files to Markdown format. It provides a simple graphical user interface for easy conversion of single or multiple HTML files.

Features

  • Convert single or multiple Unity HTML documentation files to Markdown
  • Option to merge multiple files into a single Markdown file
  • Clean conversion that removes links, images, and unnecessary HTML elements
  • User-friendly graphical interface

Requirements

  • Python 3.6 or higher
  • PyQt6
  • BeautifulSoup4
  • html2text

Installation

  1. Clone this repository or download the unity2markdown.py file.
git clone https://github.com/midnightroachmedia/Unity2Markdown

  1. Install the required Python libraries:

    pip install PyQt6 beautifulsoup4 html2text

Usage

  1. Run the application:

    python unity2markdown.py

  2. Use the interface to select HTML files, choose an output directory, and start the conversion.

  3. For detailed usage instructions, please refer to the USER-GUIDE.md file.

Contributing

Contributions to Unity2Markdown are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.