An mdBook under docs/ rendering eight pages: introduction, installation, first-run/config, downloading, an anti-bot guide that captures the hard-won cookies/curl_cffi/POT/player-client knowledge, troubleshooting (the nine error classes + non-download issues), architecture (the two-front-ends/one-engine design, settings flow, layout invariant, persistence), and packaging. - .forgejo/workflows/docs.yml builds the book and publishes docs/book/ to the `pages` branch for Codeberg Pages on docs/ changes. - docs/book/ is gitignored (rendered output). - README: fix the stale backup.directory comment — every platform nests under the one library root, not a channels/ sibling split. - Add CLAUDE.md (repo guidance for Claude Code). Builds clean with mdbook 0.5; intra-doc anchor links verified. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
30 lines
660 B
Text
30 lines
660 B
Text
# Downloaded channel archives (videos, thumbnails, descriptions)
|
|
/channels/
|
|
|
|
# Rust build artifacts
|
|
/target/
|
|
|
|
# Packaging output (.deb / .rpm / .AppImage + downloaded appimagetool)
|
|
/dist/
|
|
|
|
# makepkg build artifacts (finished .pkg.tar.zst is NOT ignored)
|
|
/pkg/
|
|
/src/yt-offline/
|
|
/yt-offline/
|
|
|
|
# Rendered mdBook output (source lives in docs/src/)
|
|
/docs/book/
|
|
|
|
# Editor / OS cruft
|
|
*.swp
|
|
.DS_Store
|
|
.claude/
|
|
|
|
# Sensitive: YouTube session cookies — never commit
|
|
cookies.txt
|
|
|
|
# User-specific runtime config (bind address, password hash, etc.) — never commit
|
|
config.toml
|
|
|
|
# Runtime database (watched status, positions, password hash) — never commit
|
|
yt-offline.db
|