How leosilvagomes/repositorio-de-bordo works
Main Components
• Content Sources & Data Storage:
– Directories such as _posts (blog entries), _about, _habilities, _profissional-experience, _project-experience, _qualification, and _volunteer-experience store Markdown files that represent personal writing, resume entries, project details, and qualifications.
– The user_info.yaml file holds personalized metadata/configuration.
• Presentation & Styling:
– _layouts, _includes, and _sections directories form the core of the templating system, rendering the content.
– css and _sass directories provide styling and responsive design.
• Build & Static Site Generation:
– The static site generator (Jekyll) takes the content, templates, and assets to generate the final website.
– The _config.yaml holds configuration info for the build.
• Automation & Scripting:
– Under the scripts directory, there are shell scripts for creating, deleting, and updating content (posts, experiences, skills, qualifications, and summary).
– The scripts/process_user_info.py and update_user_info.sh help automate updates to personalized data.
• CI/CD and Deployment:
– The .github/workflows directory contains YAML files that define automation for actions like editing files, deleting files, and deploying the site (via github-pages.yml).
• Repository & Versioning:
– Git files (like .gitignore) and the project’s overall file structure support version control and integration with GitHub, including issues templates.
Relationships and Interactions
• Archive/Content Management → Static Site Generator:
– Markdown files in various content directories feed into the Jekyll system.
– The layouts, includes, and sections are used by Jekyll to assemble and render pages.
• Build Process:
– GitHub actions (from the CI/CD pipeline) watch repository changes and trigger builds.
– The generated static site is then deployed, for example, via GitHub Pages.
• Custom Automation Scripts:
– Shell scripts in the scripts folder act as helper tools for content management (creation, deletion, update) and likely modify content or configuration files.
• User Interaction:
– Though this is a personal blog/portfolio, visitor interactions will be with the static pages that are generated. The architecture separation clearly distinguishes authoring (repository management) and consumption (deployed website).
Architectural Patterns and Design Principles
• Separation of Concerns:
– The project is clearly partitioned into content (Markdown files and YAML), presentation (HTML layouts, includes, and CSS/SASS styling), and automation (scripts and CI/CD workflows).
• Static Site Generation:
– Utilizing a static site generator ensures content is pre-rendered for fast and secure delivery without a dedicated backend server.
• Modular Structure:
– The organization into directories (e.g., separate folders for professional, project, and volunteer experiences) allows for modularity and ease of future scalability or replacement of components.
• Continuous Integration/Continuous Deployment (CI/CD):
– GitHub workflows capture the build/deploy processes, ensuring reliable updates on changes.
Elements
• Clear Labels:
• Visual Distinction:
• Detailed Breakdown: