Turn documentation sites into an EPUB (Kindle-friendly).
Project description
docs2epub
Turn documentation sites into an EPUB (Kindle-friendly).
Initial focus: Docusaurus sites that expose a Next button (docs navigation).
Install (dev)
This project uses Python 3.12+.
uv sync
uv run docs2epub --help
Usage
uvx (no install)
uvx docs2epub \
https://www.techinterviewhandbook.org/software-engineering-interview-guide/ \
tech-interview-handbook.epub \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
Docusaurus “Next” crawl
# Default output is EPUB2 (Kindle-friendly) via pandoc
uv run docs2epub \
--start-url "https://www.techinterviewhandbook.org/software-engineering-interview-guide/" \
--out "dist/tech-interview-handbook.epub" \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
# Optional: build EPUB3 (ebooklib)
uv run docs2epub \
--format epub3 \
--start-url "https://www.techinterviewhandbook.org/software-engineering-interview-guide/" \
--out "dist/tech-interview-handbook.epub" \
--title "Tech Interview Handbook" \
--author "Yangshun Tay"
Roadmap
- Add additional discovery strategies:
sitemap.xml, sidebar parsing, and explicit link lists. - Optional: send-to-kindle (email), once Gmail auth is set up.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docs2epub-0.1.1.tar.gz
(30.5 kB
view details)
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 docs2epub-0.1.1.tar.gz.
File metadata
- Download URL: docs2epub-0.1.1.tar.gz
- Upload date:
- Size: 30.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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 |
feafc5f2aa2cd58af387be0a97dbe621442c5433d5a37b6abfb6a8232695c676
|
|
| MD5 |
0a2908fb9b8e636868ceadef2cf14c33
|
|
| BLAKE2b-256 |
cff22d89ca2c0d74939f54c3ee9283dc7f97dced5f20157d3346e54edcd1fde2
|
File details
Details for the file docs2epub-0.1.1-py3-none-any.whl.
File metadata
- Download URL: docs2epub-0.1.1-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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 |
796e1fcd45aaa58354ac036960209be50ee68a13dbb3917ccc8d6d75b930d3e6
|
|
| MD5 |
0d4a2d78f7a0c67c5744a649ef214b0c
|
|
| BLAKE2b-256 |
f97ba27e9bf33d459d4ae244ba75eb6598d8d0bd006cb2ef0c855c232eb319d4
|
