mirror of https://github.com/luongnv89/claude-howto.git synced 2026-04-21 21:45:58 +02:00

Files

T

Luong NGUYEN 89e89d4aa3 feat(zh): add Chinese translations in zh/ directory

Add Chinese (Simplified) translations for all documentation, organized
under a dedicated zh/ directory that mirrors the English folder structure.

Co-authored-by: tanqingkuang <tanqingkuang@users.noreply.github.com>

Translations originally contributed by @tanqingkuang in #45.
Restructured from *-CN.md suffix pattern into zh/ directory to prevent
the EPUB builder (scripts/build_epub.py collect_folder_files) from
picking up Chinese files via glob("*.md") inside module folders.

2026-04-06 23:08:54 +02:00

tests

ci: Add DevOps quality assurance with pre-commit hooks and GitHub Actions

2025-12-10 23:49:52 +01:00

build_epub.py

fix(epub): embed SVG images instead of replacing with placeholders (#46 )

2026-04-06 22:04:44 +02:00

check_cross_references.py

feat(zh): add Chinese translations in zh/ directory

2026-04-06 23:08:54 +02:00

check_links.py

refactor(ci): shift quality checks to pre-commit, CI as 2nd pass (#34 )

2026-04-02 02:20:45 +02:00

check_mermaid.py

refactor(ci): shift quality checks to pre-commit, CI as 2nd pass (#34 )

2026-04-02 02:20:45 +02:00

pyproject.toml

refactor: Move Python configuration and requirements files to scripts/ directory for better organization

2026-01-09 09:55:03 +01:00

README.md

refactor: Add new V2.0 logo with dark/light mode support to all markdown files

2026-01-09 10:36:58 +01:00

requirements-dev.txt

refactor: Move Python configuration and requirements files to scripts/ directory for better organization

2026-01-09 09:55:03 +01:00

requirements.txt

refactor: Move Python configuration and requirements files to scripts/ directory for better organization

2026-01-09 09:55:03 +01:00

sync_translations.py

Add Vietnamese (Tiếng Việt) Localization (#42 )

2026-04-06 21:34:18 +02:00

README.md

EPUB Builder Script

Build an EPUB ebook from the Claude How-To markdown files.

Features

Organizes chapters by folder structure (01-slash-commands, 02-memory, etc.)
Renders Mermaid diagrams as PNG images via Kroki.io API
Async concurrent fetching - renders all diagrams in parallel
Generates a cover image from the project logo
Converts internal markdown links to EPUB chapter references
Strict error mode - fails if any diagram cannot be rendered

Requirements

Python 3.10+
uv
Internet connection for Mermaid diagram rendering

Quick Start

# Simplest way - uv handles everything
uv run scripts/build_epub.py

Development Setup

# Create virtual environment
uv venv

# Activate and install dependencies
source .venv/bin/activate
uv pip install -r requirements-dev.txt

# Run tests
pytest scripts/tests/ -v

# Run the script
python scripts/build_epub.py

Command-Line Options

usage: build_epub.py [-h] [--root ROOT] [--output OUTPUT] [--verbose]
                     [--timeout TIMEOUT] [--max-concurrent MAX_CONCURRENT]

options:
  -h, --help            show this help message and exit
  --root, -r ROOT       Root directory (default: repo root)
  --output, -o OUTPUT   Output path (default: claude-howto-guide.epub)
  --verbose, -v         Enable verbose logging
  --timeout TIMEOUT     API timeout in seconds (default: 30)
  --max-concurrent N    Max concurrent requests (default: 10)

Examples

# Build with verbose output
uv run scripts/build_epub.py --verbose

# Custom output location
uv run scripts/build_epub.py --output ~/Desktop/claude-guide.epub

# Limit concurrent requests (if rate-limited)
uv run scripts/build_epub.py --max-concurrent 5

Output

Creates claude-howto-guide.epub in the repository root directory.

The EPUB includes:

Cover image with project logo
Table of contents with nested sections
All markdown content converted to EPUB-compatible HTML
Mermaid diagrams rendered as PNG images

Running Tests

# With virtual environment
source .venv/bin/activate
pytest scripts/tests/ -v

# Or with uv directly
uv run --with pytest --with pytest-asyncio \
    --with ebooklib --with markdown --with beautifulsoup4 \
    --with httpx --with pillow --with tenacity \
    pytest scripts/tests/ -v

Dependencies

Managed via PEP 723 inline script metadata:

Package	Purpose
`ebooklib`	EPUB generation
`markdown`	Markdown to HTML conversion
`beautifulsoup4`	HTML parsing
`httpx`	Async HTTP client
`pillow`	Cover image generation
`tenacity`	Retry logic

Troubleshooting

Build fails with network error: Check internet connectivity and Kroki.io status. Try --timeout 60.

Rate limiting: Reduce concurrent requests with --max-concurrent 3.

Missing logo: The script generates a text-only cover if claude-howto-logo.png is not found.