$ show yeasy/docker_practice
This repository is a comprehensive Chinese-language Docker tutorial and technical book ('Docker ไปๅ ฅ้จๅฐๅฎ่ทต') rather than a traditional software service. The dominant content is structured Markdown chapters covering Docker introduction, installation, images, containers, registries, Dockerfile best practices, Compose, Kubernetes, cloud integrations, security, observability, and practical case studies. It also contains validated example code such as Dockerfiles, Compose files, and Kubernetes manifests, plus a custom toolchain for building static HTML and PDF output. The repository operates as a documentation publishing pipeline. Markdown sources are consumed by npm scripts and Python tools: prepare_pdf_sources.py inlines images as data URIs for PDF generation; build_html_reader.py creates a single-file offline HTML reader with Mermaid and dark-mode support; verify_artifacts.py checks generated artifacts and produces SHA256 manifests. CI workflows on GitHub Pages build and deploy the site, run link checks, validate examples with native tools such as kubeconform and actionlint, and enforce CJK typography rules. Architecturally, this is a collection of small, mostly standalone Python and Node scripts plus CI workflow orchestration; there is no long-running backend or service. Key entry points are package.json scripts and the tools/ and tests/ directories. The data flow is document transformation: Markdown to HTML and PDF, with example validation performed during CI. External dependencies include mdPress, mermaid-cli, pandoc, and container runtime tooling for validating the examples. Maintenance is active and changelog-driven, with frequent updates tracking Docker and Kubernetes versions. Some mirror lists and example image tags inevitably become stale as the ecosystem moves, but the CI and test layers keep the content and build pipeline in good shape. The most reusable value lies in the documentation tooling and validation patterns, not in the tutorial prose itself.
The LLM identified 5 files worth highlighting for reuse:
Preprocesses Markdown for PDF output by converting relative image references to data URIs without modifying the original source files. This transformation is generic and can be extracted into any Markdown-to-PDF publishing pipeline.
Bundles a documentation tree into a single self-contained offline HTML reader, including Mermaid SVG rendering and dark-mode CSS. This is a reusable pattern for distributing documentation as a portable offline artifact.
Verifies generated HTML and PDF artifacts for expected titles and emits SHA256 manifests for release assets. The validation approach is simple enough to adapt to any build artifact workflow.
Runs native validators against documentation examples such as Dockerfiles, Compose files, Kubernetes manifests, and GitHub Actions workflows, with a shim that permits local skips and forces validation in CI. This is a transferable pattern for keeping documentation examples truthful.
Lints Chinese/English spacing, full-width punctuation, and emphasis rendering in Markdown. This is directly reusable for any Chinese technical documentation repository that wants consistent typography.