Skip to content

README.md

Latest commit

 

History

History
213 lines (156 loc) · 7.06 KB

README.md

File metadata and controls

213 lines (156 loc) · 7.06 KB
Raw
Claude How To

Build Scripts

This directory contains two generators that turn the tutorial markdown files into distributable formats:

Both treat the .md files as the single source of truth — re-run the relevant script after editing markdown to regenerate the output.

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 the local mmdc CLI (no network required)
  • Caches identical diagrams so each unique diagram is rendered only once
  • 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
  • mmdc on PATH for Mermaid diagram rendering (npm install -g @mermaid-js/mermaid-cli)

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]
                     [--mmdc-path MMDC_PATH] [--lang {en,vi,zh,ja}]
                     [--puppeteer-config PUPPETEER_CONFIG]

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
  --mmdc-path PATH      Path to mmdc binary (default: mmdc from PATH)
  --lang {en,vi,zh,ja}  Language to build (default: en)
  --puppeteer-config P  Puppeteer config JSON passed to mmdc via -p

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

# Build a translated edition
uv run scripts/build_epub.py --lang vi

# Point at an mmdc that is not on PATH
uv run scripts/build_epub.py --mmdc-path ./node_modules/.bin/mmdc

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 pillow \
    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
pillow Cover image generation

Troubleshooting

Build fails with mmdc not found: Install the Mermaid CLI (npm install -g @mermaid-js/mermaid-cli), or pass --mmdc-path if the binary is not on PATH. There is no working arm64 build of the bundled Chromium, so on arm64 machines build the EPUB in CI instead — the build-epub job in .github/workflows/test.yml covers every language.

mmdc fails in CI or a container: Chromium needs a sandbox-free profile. Write {"args":["--no-sandbox","--disable-setuid-sandbox"]} to a file and pass it via --puppeteer-config.

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

Static Website Builder

Generate an elegant, mobile-friendly static website from the same markdown files used by the EPUB build. The website is the rendered view; the .md files remain the single source of truth.

Features

  • One HTML page per markdown source — internal .md links are rewritten to the corresponding pages on the site
  • References to non-markdown repo files (templates, scripts, JSON) become GitHub blob URLs that open the source on github.com
  • Mermaid diagrams render client-side via mermaid.min.js, served from the built site (no CDN at runtime)
  • Tailwind CSS compiled with the standalone CLI (Go binary, no Node.js) and served from the built site — responsive layout with sidebar nav, in-page TOC, dark mode toggle, and prev/next page navigation
  • Inter + JetBrains Mono fonts are self-hosted alongside the CSS — no third-party requests at page load
  • Mirrors the EPUB curriculum order (01- … 10- plus top-level docs)
  • Hostable as plain static files — designed to deploy to GitHub Pages

Quick Start

# Build the English website into ./site/
uv run scripts/build_website.py

# Preview locally
python -m http.server --directory site 8080
# then open http://localhost:8080

Command-Line Options

usage: build_website.py [-h] [--root ROOT] [--output OUTPUT]
                        [--lang {en,vi,zh,ja,uk}] [--repo-url REPO_URL]
                        [--branch BRANCH] [--verbose]

options:
  --root, -r ROOT       Source root (default: repo root)
  --output, -o OUTPUT   Output directory (default: <repo>/site)
  --lang LANG           Language to build: en | vi | zh | ja | uk
  --repo-url URL        GitHub repo for blob links (default: luongnv89/claude-howto)
  --branch BRANCH       Branch for blob links (default: main)
  --verbose, -v         Enable verbose logging

GitHub Pages Deploy

The repo ships a workflow at .github/workflows/pages.yml that builds the site on every push to main (when any .md or generator file changes) and publishes via actions/deploy-pages. Enable GitHub Pages in repo settings with Source: GitHub Actions to activate it.

Architecture

build_website.py reuses the chapter-ordering logic from build_epub.py and ships HTML templates under scripts/website_templates/:

  • page.html.j2 — per-page Jinja2 template with sidebar nav, TOC, prev/next
  • tailwind.config.js, tailwind.input.css — config + entry CSS for the Tailwind standalone CLI; the CLI scans the built HTML and produces site/assets/tailwind.css with just the utilities actually used
  • site.css — small layer of site-specific styles plus Pygments theme

The Tailwind CLI binary, Mermaid bundle, and font files are downloaded on first build into scripts/.vendor-cache/ (gitignored) — see scripts/vendor_assets.py.

Heading anchors are generated using the exact algorithm in check_cross_references.heading_to_anchor, so #anchor links validated by the pre-commit hook resolve correctly on the rendered site.