How logoff/ose-srd-es works
Main Components
a) Documentation Generation System:
• MkDocs Engine (Core)
• Markdown Content Repository
• Static Site Generator
• GitHub Pages Deployment
b) Content Management:
• Source Content Organization
• Asset Management (images)
• Styling System
[Content Layer]
• Markdown Files (src/)
• Game Rules
• Character Classes
• Spells
• Monsters
• Assets (src/img/)
• Images
• Styling (src/stylesheets/)
• CSS
[Build Layer]
• MkDocs Engine
• Configuration (mkdocs.yml)
• Build Process
[Deployment Layer]
• GitHub Actions
• Build Workflow
• GitHub Pages
• Hosted Documentation
Component Relationships
• Content files feed into MkDocs
• MkDocs processes content using configuration
• GitHub Actions triggers builds
• Built site deploys to GitHub Pages
Additional Elements
• A development workflow section
• Both Docker and non-Docker paths
• Testing/preview capabilities
• Content organization structure
• Clear separation of content, build, and deployment layers
• Automated workflow from content to published site
• Multiple development paths (Docker vs. non-Docker)
• Content organization structure