How maxgripe/skunk-html works
Key Components to Include:
Source Components
• Markdown Files (in /markdown-blog/)
• HTML Fragments (in /html/)
• Static Assets (CSS, fonts, scripts)
Build Process
• GitHub Actions Trigger
• F# Processing Engine (Program.fs)
• FSharp.Formatting Library integration
Output/Deployment
• "Generated Website" component:
• Static HTML output
• GitHub Pages hosting
• Giscus Comments System integration
[Source Files] → [Build Process] → [Deployment/Output]
Component Relationships
• How Markdown files flow into the F# processor
• How HTML fragments are incorporated
• How static assets are copied
• The deployment flow to GitHub Pages
Detailed Component Breakdown:
[Source Files]
• Markdown Content
• /markdown-blog/*.md
• HTML Templates
• /html/*.html
• Static Assets
• /css/
• /fonts/
• /scripts/
[Build Process]
• GitHub Actions Trigger
• F# Processing Engine
• Program.fs
• SkunkHtml.fs
• SkunkUtils.fs
• FSharp.Formatting
[Output/Deployment]
• Generated Static Site
• skunk-html-output/
• GitHub Pages Hosting
• Giscus Comments
Important Elements to Highlight:
Automation Flow
• How GitHub Actions automatically triggers the build process when changes are pushed
• Automated deployment to GitHub Pages
Integration Points
• Where external services connect (Giscus comments)
• Where static assets are incorporated
• Template insertion points
Processing Pipeline
• Markdown to HTML conversion process
• Where styling and scripts are applied
• Where templates are merged
• Symbols for files, directories, processes, and services