How afonsoneto/personal-website works
Main Components
• Jekyll Engine: At the core of the project is the Jekyll static site generator that reads the content, interprets the layouts/templates, and builds the final HTML.
• Content Files: These include markdown files such as index.md and online_cv.md, which contain the main content of the website.
• Layouts & Templates: The _layouts directory (with files like default.html, page.html, and post.html) and the _includes directory (with partials such as head.html, sidebar.html) form the structural and reusable components of the site pages.
• Internationalization (i18n): The _i18n directory holds language files (e.g., en.yml and pt-BR.yml), which allow for multi-language support.
• Assets: The assets folder contains styling (CSS/SCSS in assets/css/override.scss), images, and documentation (such as the resume files) which are used to style and populate the site.
• Continuous Integration (CI): The .circleci folder contains configuration for CI/CD pipelines (e.g., .circleci/config.yml), which are used to automate tests and deployment.
• Dependencies & Configuration: Files such as Gemfile, Gemfile.lock, and _config.yml reveal dependencies (Ruby Gems for Jekyll) and general site configuration.
Relationships and Interactions
• The Jekyll engine is central: it processes content files (markdown documents), combines them with layouts and includes, and leverages internationalization files to generate the final static HTML.
• Assets are referenced by the layouts and content files to render the styling, images, and documents.
• The CI/CD pipeline (from the .circleci config) automates the build process: whenever content or template changes are pushed to the repository, CircleCI triggers a build using the Gemfile dependencies and Jekyll commands.
• The project configuration (_config.yml) tells Jekyll about site-specific settings and parameters (such as baseURL, plugins, etc.).
Architectural Patterns and Technologies
• Static Site Generation: The architecture is centered on static site generation, meaning that all rendering happens at build time (there’s no dynamic backend).
• Separation of Concerns: The project is neatly segmented between content (markdown files), presentation (layouts and includes), styling/assets, and build/deployment pipelines.
• Internationalization: Built-in support for multiple languages via configuration (provided by the _i18n directory).
• CI/CD Automation: Integration with CircleCI ensures that deployments are automated and consistent.