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
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.0.tar.gz
(30.3 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.0.tar.gz.
File metadata
- Download URL: docs2epub-0.1.0.tar.gz
- Upload date:
- Size: 30.3 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 |
9cb537f9be8ea90511f7da54042fe04be806aba100566c17090b5df61261579f
|
|
| MD5 |
ae73dc8882bf32f3b01dfa9ad5b3eb86
|
|
| BLAKE2b-256 |
157f3f083b734e4c8d89ee3f8860bfe767b0dc0244ac32f0678bbdff1dd5327e
|
File details
Details for the file docs2epub-0.1.0-py3-none-any.whl.
File metadata
- Download URL: docs2epub-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.4 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 |
2a8a54e127d8512d9e2ffe535a2e2828c7d7d1aa52e52d9f6d19142b2fe382d6
|
|
| MD5 |
f45ad3d30ac90c932d273637823593e9
|
|
| BLAKE2b-256 |
172ceb0367e87df1727091794d9f531ae57433af4f7442ce261194477fe499c2
|
