markdown-this
Extract the readable content of a URL and convert it to Markdown. The package also handles GitHub repositories and Markdown files through the GitHub API, and arXiv abstract pages through their HTML representation.
Installation
uv add markdown-this
Usage
from markdown_this import extract_main_content
title, markdown, fallback_text, intro = extract_main_content(
"https://example.com/article"
)
The source can also be a local HTML file (Path or path string) or raw HTML:
from pathlib import Path
from markdown_this import extract_main_content
title, markdown, fallback_text, intro = extract_main_content(Path("article.html"))
title, markdown, fallback_text, intro = extract_main_content("<html><p>...</p></html>")
extract_main_content returns the title, extracted Markdown, plain-text
fallback, and a short introduction suitable for a notification or preview.
The Markdown value starts with YAML front matter containing the metadata that
was found, such as title, author, url, and date.
For example:
---
title: An article
author: An author
url: https://example.com/article
date: 2026-08-06
---
Article content.
The package also installs a markdown-this command:
markdown-this https://example.com/article
markdown-this article.html
cat article.html | markdown-this -
The command writes the extracted Markdown to stdout. Its input may be a URL, an existing HTML path, or HTML read from stdin.
The lower-level fetchers and normalization helpers are available from the package modules when an application needs more control over the pipeline.
Development
uv run pytest packages/markdown-this/tests
uv run ruff check packages/markdown-this
License
MIT
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdown_this-0.1.2.tar.gz.
File metadata
- Download URL: markdown_this-0.1.2.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9b0c1d8f117863cd09b8631ba586b1d05134a65360d258c0cf955f505044ce44
|
|
| MD5 |
1a06696a1c8e66fb21d498897ab59853
|
|
| BLAKE2b-256 |
512f64e0394dac28239ce59fe9017cd60b4c5f20ce7b4ea3ff66cd1f875793bc
|
File details
Details for the file markdown_this-0.1.2-py3-none-any.whl.
File metadata
- Download URL: markdown_this-0.1.2-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02ebf3dc936b3ad137fc559451d83000aee8401a6ec8b66cea0e3c7823ab8450
|
|
| MD5 |
b0690452f425dd0292deb293cfad7f97
|
|
| BLAKE2b-256 |
4ba0b894c82a7d1abacdd60cf374d6101ed5438a0dea6eb1849077f77b0b1f16
|
