Skip to main content

Convert an article or web page to Markdown

Project description

article-to-md

A CLI tool to extract core content from webpages or local HTML and convert it to Markdown.

Usage: article-to-md [OPTIONS] SOURCE

Convert an article or web page to Markdown.

Commands:
  --help, -h: Display this message and exit.
  --version: Display application version.

Parameters:
  SOURCE, --source: A URL or local HTML file to process. [required]
  --method: The extraction engine to use. [choices: readability, trafilatura, raw] [default: readability]
  --favor: Whether to favor 'precision' or 'recall' when using trafilatura. [choices: recall, precision]
  --remove-ads, --no-remove-ads: Apply EasyList cosmetic filters to remove ads before processing. [default: False]
  --strip-tag, --no-strip: HTML tag to strip from the final output. Repeat this flag to remove multiple tags. Use --no-strip to disable. [default: ('img',)]

Installation

uv is recommended to install the package in a managed environment:

uv tool install article-to-md

Note: To use the readability method, Node.js (v14+) must be installed on your system. Without Node.js, the tool uses Python-based extraction.

Usage

From a publicly accessible web page:

article-to-md https://example.com/article

From a local HTML file:

article-to-md /path/to/file.html

Advanced options:

  • --remove-ads - Basic ad removal from the DOM using generic cosmetic filters from EasyList
  • --method - Affects pre-processing of the DOM before conversion to Markdown.
    • readability (default) - Uses ReadabiliPy which can use the original Readability.js Node package when Node is present on the system.
    • trafilatura - Uses the Trafilatura pure Python library
    • raw - Sends the full DOM to be converted
  • --favor - Only used with --method trafilatura to control options documented here.
  • --strip-tag - An HTML tag to be stripped from the DOM before conversion
    • This argument can be supplied multiple times
    • By default, <img> tags are stripped; use --no-strip to keep them.

Features

  • Stealth Requests: Uses curl_cffi to impersonate a Chrome browser and avoid bot detection.
  • Enhanced Markdown:
    • Converts <var> to italics.
    • Includes <abbr> titles in the text output.
    • Renders Markdown tables from HTML tables

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

article_to_md-0.4.2.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

article_to_md-0.4.2-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file article_to_md-0.4.2.tar.gz.

File metadata

  • Download URL: article_to_md-0.4.2.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for article_to_md-0.4.2.tar.gz
Algorithm Hash digest
SHA256 8e239615896ad010bf0c0cef991b503394865a94971de85247284c15de70a56b
MD5 28369c884ed704a6c99f1fef5b0b6a58
BLAKE2b-256 a2fb1368a612c1def3c3fe8c938c4129a0f1b04f5d9337292e65f0e66aff05cf

See more details on using hashes here.

File details

Details for the file article_to_md-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: article_to_md-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for article_to_md-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b68f035d1ea6f6b12a2c103c14df7b7fb6c223b2c8cf3e0917650d0bbaa326bc
MD5 1a3bf2f78947c52ca7f96d2c213f7b3c
BLAKE2b-256 a4073596754e8f5120f2a807410daadf97947d01dfefd9dcd0c54bcd07d819c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page