Skip to main content

A CLI tool to convert a webpage to markdown

Project description

markitdown-cli

PyPI version License: MIT

A lightweight CLI wrapper for Microsoft's markitdown library. Convert any webpage into a clean Markdown file directly from your terminal.

Installation

The recommended way to install markitdown-cli is using pipx:

pipx install markitdown-cli

Alternatively, you can install it with pip:

pip install markitdown-cli

Usage

The primary use case is to provide a URL to the tool. markitdown-cli will then download the page, convert it to Markdown, and save it as a file in your current directory.

Basic Usage

markitdown-cli https://example.com/article

This will create a file named article.md in the current directory.

Interactive Title Suggestion

The tool will suggest a title for the Markdown file based on the URL. You can either accept the suggestion by pressing Enter, or you can type a custom title.

$ markitdown-cli https://collabfund.com/blog/the-dumber-side-of-smart-people/
Suggested title [the-dumber-side-of-smart-people]:
Wrote: the-dumber-side-of-smart-people.md

Specifying an Output Directory

You can use the -o or --outdir option to specify a different directory to save the Markdown file.

markitdown-cli https://example.com/article -o ./my-articles

This will create article.md inside the my-articles directory.

License

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

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

markitdown_cli-0.1.2.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

markitdown_cli-0.1.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file markitdown_cli-0.1.2.tar.gz.

File metadata

  • Download URL: markitdown_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for markitdown_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1f4bab3f029a76e993de9177132dcab50eb965fce3c4dc248c662314fea351ab
MD5 37a1c3476a2cf30740ec048a12f6a2bf
BLAKE2b-256 fc9211369dfb9525d0775fbb667d92672464a405380e4c5e3c61f87762fb7e72

See more details on using hashes here.

File details

Details for the file markitdown_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: markitdown_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for markitdown_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e0dd3a8cdc221f27e1c6cef3f26eb93c52cff3bead50147c4ca4272f487f8b7a
MD5 57c042cf0d30bed821ce4069f71c07fd
BLAKE2b-256 feccfc74dd73871028a314c74ff1cf70652b894bc46d5346805da6a8e5113c92

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