https://github.com/iaseth/svelte-docs-epub

Svelte docs as EPUB ebooks.
https://github.com/iaseth/svelte-docs-epub

azw3 beautifulsoup ebook epub jinja2 kindle python3 requests svelte svelte-documentation sveltekit

Last synced: 5 months ago
JSON representation

Svelte docs as EPUB ebooks.

• Host: GitHub
• URL: https://github.com/iaseth/svelte-docs-epub
• Owner: iaseth
• License: mit
• Created: 2025-05-07T03:40:33.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2025-05-07T07:19:30.000Z (5 months ago)
• Last Synced: 2025-05-08T00:11:44.158Z (5 months ago)
• Topics: azw3, beautifulsoup, ebook, epub, jinja2, kindle, python3, requests, svelte, svelte-documentation, sveltekit
• Language: Python
• Homepage:
• Size: 2.67 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# 📚 svelte-docs-epub

This project builds clean, Kindle/ereader-friendly **EPUB** and **AZW3** versions of the official documentation for:

- [Svelte](https://svelte.dev/docs/svelte)

- [SvelteKit](https://svelte.dev/docs/kit)

- [svelte-cli](https://svelte.dev/docs/cli)

All styling is stripped for full compatibility with Kindle and other e-ink devices. The content is fully navigable with TOC, proper chapters, and readable code blocks using default system fonts.

---

## 🖼️ Screenshots

| Book       | Image 1                                       | Image 2                                       | TOC                                               |

|------------|-----------------------------------------------|-----------------------------------------------|---------------------------------------------------|

| Svelte     | ![sveltedocs-1](svelteshots/sveltedocs-1.png) | ![sveltedocs-2](svelteshots/sveltedocs-2.png) | ![sveltedocs-toc](svelteshots/sveltedocs-toc.png) |

| SvelteKit  | ![sveltekit-1](svelteshots/sveltekit-1.png)   | ![sveltekit-2](svelteshots/sveltekit-2.png)   | ![sveltekit-toc](svelteshots/sveltekit-toc.png)   |

| Svelte CLI | ![svelte-cli-1](svelteshots/svelte-cli-1.png) | ![svelte-cli-2](svelteshots/svelte-cli-2.png) | ![svelte-cli-toc](svelteshots/svelte-cli-toc.png) |

---

## 📥 Download Latest eBooks (2025-05-07)

| Format | Svelte | SvelteKit | svelte-cli |

|--------|--------|-----------|-------------|

| **EPUB** | [📘 svelte-docs.epub](ebooks/2025-05-07/svelte-docs.epub) | [📘 sveltekit-docs.epub](ebooks/2025-05-07/sveltekit-docs.epub) | [📘 svelte-cli-docs.epub](ebooks/2025-05-07/svelte-cli-docs.epub) |

| **AZW3** | [📗 svelte-docs.azw3](ebooks/2025-05-07/svelte-docs.azw3) | [📗 sveltekit-docs.azw3](ebooks/2025-05-07/sveltekit-docs.azw3) | [📗 svelte-cli-docs.azw3](ebooks/2025-05-07/svelte-cli-docs.azw3) |

> ✅ Optimized for Kindle and Kobo  

> ✅ Fully offline  

> ✅ No external dependencies or styling  

> ✅ Lightweight and versioned

---

## 🛠️ How It Works

- Scrapes official docs using **Python** + **requests** + **BeautifulSoup**

- Uses **Jinja2** templates to generate valid EPUB structure

- Packages all assets manually for EPUB

- Uses **Calibre CLI** (`ebook-convert`) to generate AZW3 from EPUB

- Stores eBooks under `ebooks/YYYY-MM-DD/` for version tracking

---

## 📦 Project Structure

```text

ebooks/

  └── YYYY-MM-DD/

      └── [EPUB and AZW3 files]

pypub/

  ├── epub.py

  └── templates/

      ├── chapter.xhtml.j2

      ├── content.opf.j2

      └── toc.ncx.j2

static/

  └── container.xml

svdocs.py  ← main build script

svelteshots/ ← output screenshots

````

---

## 🚧 Roadmap

* [ ] Inline Table of Contents at the start of the book

* [ ] Cross-reference linking between sections

* [ ] Optional minimal syntax highlighting (Kindle-safe)

* [ ] GitHub Action to auto-build from latest docs weekly

---

## 📝 License

MIT License © 2025 [iaseth](https://github.com/iaseth)