How mnadhro/nadirolabi-web-corner works
Project Type and Purpose
• This is a static documentation-style personal website built with MkDocs (a Python-based static site generator).
• Markdown files in docs/ represent content; custom themes and CSS in styling_/ define styling.
• It’s deployed via Cloudflare Pages from a GitHub repository.
File Structure Overview
• Top-level:
• mkdocs.yml (MkDocs configuration)
• requirements.txt (Python deps including mkdocs and theme plugins)
• docs/ (Markdown content and assets)
• styling_/ (three custom MkDocs themes: bootswatch_theme, cinder, terminal_theme)
• docs/stylesheets and docs/vx_images (content-specific CSS & images)
• No backend code or database—purely static site generator and theming.
Main Components
a. Source Code Repository (GitHub)
• Contains Markdown pages, theme packages, config files.
b. Continuous Deployment (Cloudflare Pages)
• Watches the GitHub repo, triggers builds on commit.
c. Build System (MkDocs + Python environment)
• mkdocs.yml defines site structure, theme, plugins (tile_grid, etc.).
• Python runtime installs dependencies via requirements.txt.
• MkDocs assembles HTML/CSS/JS into a static site.
d. Themes & Plugins
• Three theme packages: Bootswatch variants, Cinder, Terminal.
• MkDocs plugin md_to_html and tile_grid pluglets process content.
e. Static Assets
• CSS, JS, fonts, images output by MkDocs into a deployable folder.
f. CDN & Browser
• Deployed static files served by Cloudflare CDN to end users’ browsers.
Component Relationships and Data Flow
• Developer → Push to GitHub (source commit)
• GitHub Webhook → Cloudflare Pages build trigger
• Cloudflare Pages → Clone repo → Install Python deps → Run MkDocs build
• MkDocs → Read docs/, apply styling_/ themes & plugins → Generate static site
• Build Output → Deployed to Cloudflare CDN
• End User Browser ← HTTP GET ← Cloudflare CDN ← Static files
Architectural Patterns & Design Principles
• Separation of Concerns: Content (Markdown) vs. Presentation (themes/CSS) vs. Deployment (Cloudflare).
• Plugin-based extension: MkDocs plugins and pluglets for custom macros (tile_grid).
• Infrastructure as code: mkdocs.yml and requirements.txt drive build reproducibility.
• CI/CD Pipeline: Continuous deployment on every push, zero-server static hosting.
Detail
• Call out mkdocs.yml, requirements.txt as configuration inputs.
• That there is no dynamic server or database—everything is pre-built.
• Versions or tech stack notes (Python, MkDocs, Cloudflare Pages).