How ftc32477/quick-start-guide works
This repository is a multilingual guide publishing system: maintainers author Markdown and shared images, build.py generates the language portal and guide pages, and build_pdf.py exports print-ready PDFs from those pages. Readers enter through the language portal, browse localized chapters and version history, or access published PDFs. The README documents PDF layout, font subsets, and release links. Source excerpts are partial, so edges for documented build and navigation behavior rely on the README where appropriate; unsampled implementation details are not inferred.
Main entry points: index.html Language home · build_pdf.py PDF exporter · build.py HTML builder · build_subsets.py Subset generator
Components 14
Guide content
- Localized Markdown
src - Shared images
images
Web publishing
- HTML builder
build.py - Language portal
dist/index.html - Language home
dist/en-us/index.html - Guide chapters
src/en-us - Version history
dist/en-us/versions.html
PDF export
- PDF exporter
build_pdf.py - Guide PDFs
PDF fonts
- Font subsets
fonts/subsets - Subset generator
fonts/build_subsets.py
Other components
- Reader
- Maintainer
- Chrome or Edge
Connections 20
- Reader → Language portal: opens
README.md - Language portal → Language home: selects language
README.md - Maintainer → Localized Markdown: edits
README.md - Localized Markdown → HTML builder: provides content
README.md - Shared images → HTML builder: provides assets
README.md - HTML builder → Language portal: generates
README.md - HTML builder → Language home: generates
README.md - HTML builder → Guide chapters: renders pages
README.md - Language home → Guide chapters: navigates to
- Language home → Version history: links to
- Reader → Language home: opens
README.md - Maintainer → PDF exporter: runs export
README.md - PDF exporter → Chrome or Edge: renders pages
README.md - PDF exporter → Language home: reads HTML
build_pdf.py - PDF exporter → Font subsets: loads fonts
README.md - PDF exporter → Guide PDFs: writes PDFs
README.md - Maintainer → Subset generator: runs when needed
README.md - Subset generator → Font subsets: generates subsets
fonts/build_subsets.py - Subset generator → PDF exporter: checks coverage
fonts/build_subsets.py - Language home → Guide PDFs: links release PDFs