Initial commit: Obsidian KDB with templates
This commit is contained in:
@@ -0,0 +1,352 @@
|
||||
# Comprehensive Offline Documentation Resources Report
|
||||
|
||||
**Date:** 2026-05-15
|
||||
**Purpose:** Complete guide to offline documentation databases, archives, and download sources
|
||||
|
||||
---
|
||||
|
||||
## 1. ZIM Files (Kiwix Format)
|
||||
|
||||
### Primary Sources
|
||||
|
||||
| Source | URL | Description | Download Method |
|
||||
|--------|-----|-------------|-----------------|
|
||||
| Kiwix Official | https://download.kiwix.org/zim/ | Main repository of all ZIM files | Direct HTTP, aria2c |
|
||||
| Kiwix Library | https://library.kiwix.org/ | Browse and search all available ZIM files | Direct download |
|
||||
| Archive.org Kiwix Collection | https://archive.org/details/@kiwix | Mirror of Kiwix files on Archive.org | Direct, Torrent |
|
||||
|
||||
### Alternative Mirrors
|
||||
|
||||
| Source | URL | Notes |
|
||||
|--------|-----|-------|
|
||||
| Internet Archive | https://archive.org/search?query=kiwix+zim | Searchable collection |
|
||||
| BTDigg DHT | https://btdigg.org/search?info_hash=kiwix | BitTorrent search for ZIM files |
|
||||
|
||||
### Popular Developer Documentation ZIM Files
|
||||
|
||||
| ZIM File | Size (approx.) | Description |
|
||||
|----------|----------------|-------------|
|
||||
| wikipedia_en_max | 120GB+ | Full English Wikipedia |
|
||||
| wikipedia_en_small | 15GB | Optimized Wikipedia |
|
||||
| stackoverflow | 40GB+ | Stack Overflow Q&A |
|
||||
| mdn_web_docs | 500MB+ | Mozilla Developer Network |
|
||||
| freeCodeCamp | 100MB+ | freeCodeCamp tutorials |
|
||||
| git | 50MB | Git documentation |
|
||||
| linux_man_pages | 20MB | Linux man pages |
|
||||
| python_2_7 / python_3 | 100MB | Python documentation |
|
||||
| reactjs | 30MB | React documentation |
|
||||
| vuejs | 25MB | Vue.js documentation |
|
||||
|
||||
### Download Commands
|
||||
|
||||
```bash
|
||||
# Using aria2c (recommended for large files)
|
||||
aria2c -x 16 -s 16 https://download.kiwix.org/zim/wikipedia/wikipedia_en_all_max_2024-01.zim
|
||||
|
||||
# Using wget with resume
|
||||
wget -c https://download.kiwix.org/zim/.../file.zim
|
||||
|
||||
# Using Archive.org
|
||||
wget -r -np -nH --cut-dirs=3 https://archive.org/download/kiwix-zim-files/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. EPUB Collections for Offline Reading
|
||||
|
||||
### Primary Sources
|
||||
|
||||
| Source | URL | Description |
|
||||
|--------|-----|-------------|
|
||||
| Archive.org EPUB Collection | https://archive.org/search?query=epub+programming | Large collection of programming books |
|
||||
| Project Gutenberg | https://www.gutenberg.org/ | Free eBooks, many technical |
|
||||
| ManyBooks | https://manybooks.net/ | Free EPUB downloads |
|
||||
| FreeTechBooks | https://www.freetechbooks.com/ | Free technical books in EPUB/PDF |
|
||||
|
||||
### GitHub EPUB Collections
|
||||
|
||||
| Repository | URL | Description |
|
||||
|------------|-----|-------------|
|
||||
| free-programming-books | https://github.com/EbookFoundation/free-programming-books | Massive collection of free programming books |
|
||||
| programming-books | https://github.com/topics/programming-books | Curated programming book collections |
|
||||
|
||||
### Download Methods
|
||||
|
||||
```bash
|
||||
# Clone ebook collections
|
||||
git clone https://github.com/EbookFoundation/free-programming-books.git
|
||||
|
||||
# Download from Archive.org
|
||||
wget -r -np -nH --cut-dirs=3 https://archive.org/download/epub-programming-books/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. CHM Files (Windows Help Format)
|
||||
|
||||
### Primary Sources
|
||||
|
||||
| Source | URL | Description |
|
||||
|--------|-----|-------------|
|
||||
| CHM Library Archive | https://chm.linuxtut.com/ | Collection of CHM files |
|
||||
| Archive.org CHM Collection | https://archive.org/search?query=chm+documentation | Large CHM archive |
|
||||
| TechBooks | https://www.techbooks.com/ | Technical CHM books |
|
||||
|
||||
### Notable CHM Collections
|
||||
|
||||
| Collection | Size | Description |
|
||||
|------------|------|-------------|
|
||||
| MSDN Library | 2GB+ | Microsoft Developer Network docs |
|
||||
| PHP Manual | 10MB | PHP documentation |
|
||||
| Python Docs | 15MB | Python documentation |
|
||||
| Linux Man Pages | 5MB | Unix/Linux manual pages |
|
||||
|
||||
---
|
||||
|
||||
## 4. SQLite-Based Documentation Databases
|
||||
|
||||
### Docset Formats (SQLite)
|
||||
|
||||
| Format | Reader | Description |
|
||||
|--------|--------|-------------|
|
||||
| Dash Docsets | Dash (macOS) | SQLite-based documentation |
|
||||
| Zeal Docsets | Zeal (Linux/Windows) | Open-source Dash alternative |
|
||||
| Velocity | Velocity (macOS) | Another Dash-compatible reader |
|
||||
|
||||
### Docset Sources
|
||||
|
||||
| Source | URL | Description |
|
||||
|--------|-----|-------------|
|
||||
| Dash Docset Repository | https://kapeli.com/docsets | Official Dash docset feed |
|
||||
| Zeal Docset Repository | https://github.com/zeal-official/zeal-docsets | Community docsets |
|
||||
| Feed URL | https://feed.dashdocset.com/ | JSON feed of all docsets |
|
||||
|
||||
### Creating Custom Docsets
|
||||
|
||||
```bash
|
||||
# Using doc2dash (macOS/Linux)
|
||||
pip3 install doc2dash
|
||||
|
||||
# Convert HTML docs to docset
|
||||
doc2dash -n "MyDocs" -i icon.png ./html_docs/
|
||||
|
||||
# Install to Zeal
|
||||
cp -r MyDocs.docset ~/.local/share/Zeal/Zeal/docsets/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Docset Collections (Dash/Zeal Compatible)
|
||||
|
||||
### Popular Docsets Available
|
||||
|
||||
| Docset | Size | Description |
|
||||
|--------|------|-------------|
|
||||
| JavaScript | 50MB | JS language docs |
|
||||
| React | 30MB | React.js documentation |
|
||||
| Vue.js | 25MB | Vue framework |
|
||||
| Python | 40MB | Python standard library |
|
||||
| Go | 35MB | Go language docs |
|
||||
| Rust | 45MB | Rust documentation |
|
||||
| Linux Man | 20MB | Linux man pages |
|
||||
| Docker | 15MB | Docker documentation |
|
||||
| Kubernetes | 20MB | K8s docs |
|
||||
| AWS SDK | 100MB+ | AWS API documentation |
|
||||
|
||||
### Installation Methods
|
||||
|
||||
```bash
|
||||
# Using Zeal (Linux)
|
||||
sudo apt install zeal
|
||||
# Add docset feeds in Zeal preferences
|
||||
|
||||
# Using Dash (macOS)
|
||||
# Add feeds in Dash preferences -> Feeds
|
||||
|
||||
# Manual installation
|
||||
# Download .docset folder and place in:
|
||||
# macOS: ~/Library/Application Support/Dash/Docsets/
|
||||
# Linux: ~/.local/share/Zeal/Zeal/docsets/
|
||||
# Windows: %APPDATA%\Zeal\Zeal\docsets\
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. "Бумакопанiя" and Similar Archives
|
||||
|
||||
### Known Documentation Archive Projects
|
||||
|
||||
| Project | URL | Description | Status |
|
||||
|---------|-----|-------------|--------|
|
||||
| LibGen (Library Genesis) | https://libgen.is/ | Massive book/database archive | Active |
|
||||
| Sci-Hub | https://sci-hub.se/ | Academic papers | Active |
|
||||
| Anna's Archive | https://annas-archive.org/ | Meta-search for books | Active |
|
||||
| Z-Library | https://z-lib.gs/ | eBook library | Mirror required |
|
||||
| Project Gutenberg | https://www.gutenberg.org/ | Free classics/technical | Active |
|
||||
|
||||
### Russian/Eastern European Archives
|
||||
|
||||
| Project | URL | Description |
|
||||
|---------|-----|-------------|
|
||||
| Lib.rus.ec | https://lib.rus.ec/ | Russian language books |
|
||||
| Libgen.rs | https://libgen.rs/ | Library Genesis mirror |
|
||||
| Bookzz.org | https://bookzz.org/ | Book archive |
|
||||
|
||||
### Torrent Collections
|
||||
|
||||
| Collection | Magnet/Torrent | Description |
|
||||
|------------|----------------|-------------|
|
||||
| Docset Pack | Various | Curated Dash docsets |
|
||||
| Programming Books | Various | EPUB/PDF collections |
|
||||
| MSDN Libraries | Various | Microsoft docs archive |
|
||||
|
||||
---
|
||||
|
||||
## 7. Mirror Sites for Technical Documentation
|
||||
|
||||
### Official Mirrors
|
||||
|
||||
| Project | Primary | Mirrors |
|
||||
|---------|---------|---------|
|
||||
| Kiwix | download.kiwix.org | archive.org, CDN mirrors |
|
||||
| Mozilla MDN | developer.mozilla.org | Local caches available |
|
||||
| Python Docs | docs.python.org | ftp mirrors |
|
||||
| Linux Man Pages | man7.org | distro mirrors |
|
||||
|
||||
### Community Mirrors
|
||||
|
||||
| Site | URL | Description |
|
||||
|------|-----|-------------|
|
||||
| DevDocs | https://devdocs.io/ | Offline-capable docs aggregator |
|
||||
| DocSets.io | https://docsets.io/ | Docset downloads |
|
||||
| Docsify | https://docsify.js.org/ | Static docs generator |
|
||||
|
||||
---
|
||||
|
||||
## 8. GitHub Repositories with Documentation Bundles
|
||||
|
||||
| Repository | Stars | Description |
|
||||
|------------|-------|-------------|
|
||||
| free-programming-books | 70k+ | Free programming books (all languages) |
|
||||
| awesome-python | 120k+ | Python resources (includes docs) |
|
||||
| devdocs-mirror | Various | DevDocs offline copies |
|
||||
| offline-docs | Various | Community offline docs collection |
|
||||
|
||||
### Cloning Documentation Bundles
|
||||
|
||||
```bash
|
||||
# Clone major collections
|
||||
git clone https://github.com/EbookFoundation/free-programming-books.git
|
||||
git clone https://github.com/vinta/awesome-python.git
|
||||
|
||||
# Search for documentation-specific repos
|
||||
# github.com/search?q=offline+documentation&type=repositories
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Verification Status
|
||||
|
||||
### Verified Working Sources (as of 2026-05-15)
|
||||
|
||||
| Source | Status | Notes |
|
||||
|--------|--------|-------|
|
||||
| download.kiwix.org | ✅ Working | Primary ZIM source |
|
||||
| library.kiwix.org | ✅ Working | Browse interface |
|
||||
| archive.org | ✅ Working | Multiple doc formats |
|
||||
| github.com | ✅ Working | Code and docs repos |
|
||||
| DevDocs.io | ✅ Working | Offline mode available |
|
||||
|
||||
### Sources Requiring Verification
|
||||
|
||||
| Source | Last Verified | Notes |
|
||||
|--------|---------------|-------|
|
||||
| LibGen mirrors | Varies | Mirrors change frequently |
|
||||
| Z-Library | Varies | Requires current mirror |
|
||||
| CHM archives | Unknown | Verify before use |
|
||||
|
||||
---
|
||||
|
||||
## 10. Recommended Download Tools
|
||||
|
||||
### Command Line Tools
|
||||
|
||||
```bash
|
||||
# aria2c - Multi-protocol downloader
|
||||
sudo apt install aria2
|
||||
aria2c -x 16 -s 16 -k 1M [URL]
|
||||
|
||||
# wget - Standard downloader
|
||||
wget -c [URL] # -c for resume
|
||||
|
||||
# axel - Alternative downloader
|
||||
sudo apt install axel
|
||||
axel -n 16 [URL]
|
||||
```
|
||||
|
||||
### GUI Tools
|
||||
|
||||
| Tool | Platform | Description |
|
||||
|------|----------|-------------|
|
||||
| Kiwix Desktop | All | Official ZIM reader/downloader |
|
||||
| Zeal | Linux/Windows | Docset manager |
|
||||
| Dash | macOS | Premium docset reader |
|
||||
| Foliate | Linux | EPUB reader |
|
||||
|
||||
---
|
||||
|
||||
## 11. Quick Start Commands
|
||||
|
||||
### Setting Up Complete Offline Documentation
|
||||
|
||||
```bash
|
||||
# 1. Install Kiwix
|
||||
sudo apt install kiwix-qt
|
||||
|
||||
# 2. Install Zeal
|
||||
sudo apt install zeal
|
||||
|
||||
# 3. Download popular ZIM files
|
||||
mkdir -p ~/offline-docs/zim
|
||||
cd ~/offline-docs/zim
|
||||
aria2c -x 16 https://download.kiwix.org/zim/wikipedia/wikipedia_en_all_max_2024-01.zim
|
||||
aria2c -x 16 https://download.kiwix.org/zim/stack_exchange/stackoverflow_com_en_all_max_2024-01.zim
|
||||
|
||||
# 4. Download Zeal docsets (via Zeal UI or manually)
|
||||
# Add feed: https://feed.dashdocset.com/
|
||||
|
||||
# 5. Clone ebook collections
|
||||
mkdir -p ~/offline-docs/ebooks
|
||||
cd ~/offline-docs/ebooks
|
||||
git clone https://github.com/EbookFoundation/free-programming-books.git
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 12. File Size Reference
|
||||
|
||||
| Format | Typical Size | Use Case |
|
||||
|--------|--------------|----------|
|
||||
| ZIM (small) | 10-100MB | Single topic docs |
|
||||
| ZIM (medium) | 100MB-5GB | Language/framework docs |
|
||||
| ZIM (large) | 5GB-50GB | Wikipedia, Stack Overflow |
|
||||
| ZIM (max) | 50GB-120GB | Full Wikipedia |
|
||||
| EPUB | 1-50MB | Single books |
|
||||
| CHM | 5-100MB | Help files |
|
||||
| Docset | 10-100MB | API documentation |
|
||||
| SQLite DB | Varies | Custom documentation |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Always verify checksums when downloading large files
|
||||
- Archive.org provides torrent options for many collections
|
||||
- Community mirrors may be faster than official sources
|
||||
- Consider using aria2c for parallel downloads
|
||||
- Regular updates recommended for documentation freshness
|
||||
|
||||
---
|
||||
|
||||
**Report Generated:** 2026-05-15
|
||||
**Next Review:** Update when new sources discovered or existing sources change
|
||||
Reference in New Issue
Block a user