mirror of https://github.com/luongnv89/claude-howto.git synced 2026-05-23 10:19:41 +02:00

Files

T

Luong NGUYEN 553a319934 feat(scripts): add markdown rendering validator (#119 ) (#120 )

Catches mechanical rendering bugs that look fine in a diff but render
wrong on GitHub / in the EPUB build: inner backticks inside inline-code
spans (PR #114), unescaped pipes in table cells (PR #115), stray
`$ARGUMENTS` outside code, and unmatched fences.

Scope: `**/README.md` across tutorial modules + translations (ja, uk,
vi, zh). Excludes dev tooling dirs (`.claude`, `.venv`, `openspec`, …).

Rule registry: each rule is `(Path, content) -> list[str]`. Adding a
new rule = one function + one registry entry + one test fixture.

- scripts/check_markdown_rendering.py: 4 rules, CommonMark-aware code-
  span consumption, blockquote-fence-aware masking
- scripts/tests/test_check_markdown_rendering.py: 20 unit tests,
  positive + negative per rule, currency-false-positive guard
- .pre-commit-config.yaml: new global `markdown-rendering` hook

2026-05-11 23:49:39 +02:00

tests

feat(scripts): add markdown rendering validator (#119 ) (#120 )

2026-05-11 23:49:39 +02:00

build_epub.py

feat(i18n): Add Japanese (ja/) translation (#105 )

2026-04-30 00:16:46 +02:00

check_cross_references.py

fix: constrain cross-reference resolution to repo root (#91 )

2026-04-25 00:28:03 +02:00

check_links.py

docs: sync to Claude Code v2.1.119 (docs host migration, /usage, hooks mcp_tool, native binary) (#94 )

2026-04-24 08:20:55 +02:00

check_markdown_rendering.py

feat(scripts): add markdown rendering validator (#119 ) (#120 )

2026-05-11 23:49:39 +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

ci: shift-left quality gates — add mypy to pre-commit, fix CI failures (#53 )

2026-04-07 00:51:44 +02: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

ci: shift-left quality gates — add mypy to pre-commit, fix CI failures (#53 )

2026-04-07 00:51:44 +02:00

requirements.txt

fix: pin requirements.txt to known-good versions (#90 )

2026-04-25 00:25:30 +02:00

sync_translations.py

ci: shift-left quality gates — add mypy to pre-commit, fix CI failures (#53 )

2026-04-07 00:51:44 +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.