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.5.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.5-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markitdown_cli-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 9de6d8eccdca5832a21eff5b118b282e8c7ba6e70ebb7c82475a41fe8a62f268
MD5 145dadc941614eba9bb2f5ae1a1ec015
BLAKE2b-256 7af36649c06cd8bee4df0cd6f278bab9df36efc4764e0a24977d28aeb20e8982

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markitdown_cli-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2d8c4792ff0958d7cae02d589916d8c88677b6a91d796df1bc4e1d7487c09990
MD5 c4d8ecb0922f1e60d2dbd0aec92c6f92
BLAKE2b-256 c2cdeb2f73170ca30a4586247810a5f5bb5cccfcfd4c40bfe4eebe6fa8421bfe

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