rocklandceo / html2md

html2md: Convert Web Pages to Markdown

html2md is a Python-based tool that converts web pages into clean and readable Markdown format.

Prerequisites

• Python
• Firefox Browser

Setup

1. Clone the Repository

To get started, first clone the html2md repository:

git clone https://github.com/rocklandceo/html2md.git

2. Install Dependencies

Navigate to the root directory of the html2md project and install the Python requirements:

pip install -r requirements.txt

3. Usage

This tool uses Selenium to fetch and interact with web pages, allowing for more dynamic content handling compared to simple HTTP requests. Specifically, it uses Geckodriver to run the Firefox browser in the background. Ensure you have Firefox installed on your machine.

After setting up, you can use the html2md.py script to convert web pages to Markdown:

python html2md.py

If you're using Python 3 and have both Python 2 and Python 3 installed on your machine, you might need to use:

python3 html2md.py

The script will prompt you to enter the URL of the web page you wish to convert. After processing, the converted content will be saved in the converted-files directory with a filename based on the webpage's title.

License

Please ensure you comply with the licensing terms of the tools and libraries used in this project.