README.md

This project will focus on creating documentation from various sources.

HTML to Markdown Converter

This tool converts HTML documentation into a single, well-structured Markdown file. It processes an HTML documentation starting from its index.html, including all linked pages as separate chapters in the final Markdown document.

Installation

pip install -r requirements.txt

Usage

python html_to_markdown.py <input_path> <output_path>

Where:

• input_path: Path to the folder containing the HTML documentation (must have an index.html)
• output_path: Path to the folder where the output Markdown file will be stored

The output file will be named based on the input path (with '/' replaced by '_') and include a timestamp, following the format: input_path_YYYYMMDD_HHMMSS.md

Features

• Processes all HTML files linked from the index.html
• Maintains hierarchical structure of the documentation
• Converts HTML content to clean Markdown format
• Skips external links and anchors
• Handles relative paths correctly