How tmfg/digitraffic works
Project type and purpose
• This is a static site generator project (Jekyll) that produces a documentation/marketing site (Digitraffic pages).
• Source content lives in Markdown (pages/, _posts/, _applications, _developments), templates in _layouts/_includes, styles in _scss, scripts under src/js and src/ts, and the build is orchestrated by Ruby (Bundler/Gems) plus Node (pnpm, tsconfig.json).
• It is containerized (Dockerfile, build/run scripts) to produce a web-server exposing the static site on ports 3000/3001.
File structure for architectural components
• Content layer: Markdown files (pages, _posts, _applications, _developments).
• Presentation layer: Jekyll templates (_layouts, _includes), SCSS (_scss → compiled CSS), and JavaScript/TypeScript (src/js, src/ts → bundled JS).
• Build toolchain:
– Ruby Bundler & Gems (Gemfile, bundle update)
– Node/PNPM (package.json, pnpm build-and-install, pnpm format)
– TypeScript compiler (tsconfig.json)
– SCSS compiler
• Containerization & CI: Dockerfile + entrypoint scripts, CI workflows under .github/workflows.
README for technical stack
• Uses Jekyll (Ruby + Liquid templates)
• Uses PNPM for JS/TS asset build
• Build and run in Docker
• Live-reload on port 3000, admin/status on 3001
Main components & interactions
a. Component list:
– Developer workstation (Editor + CLI)
– GitHub repo & CI
– Build orchestrator (pnpm + Bundler)
– Jekyll engine
– Asset compilers (SCSS, TypeScript)
– Docker image
– Containerized web server
– End user browser
b. Relationships:
– Developer → Git repo → CI triggers Docker build → runs Bundler & pnpm → produces static _site
– Docker container serves _site on HTTP ports
– Browser fetches HTML/CSS/JS from container
c. Architectural patterns/design principles:
– Static site generation (SSG)
– Separation of content (Markdown) from presentation (templates + styles)
– Asset pipeline (SCSS & TS → bundled CSS & JS)
– Container-based reproducible build & deploy
d. Key technologies:
– Jekyll (Ruby + Liquid)
– Bundler/Gems
– SCSS → CSS
– TypeScript/JavaScript → bundle.js
– PNPM (fast JS/TS builds)
– Docker
Final advice
– Don’t overcomplicate—break the system into logical build vs. runtime vs. content zones
– Capture essential tools (Bundler, PNPM, Jekyll, Docker) and flows (content→build→deploy→serve)