This directory contains the Jekyll-based website for the Learning AI project, hosted on GitHub Pages.
-
Install dependencies:
cd docs bundle install
-
Start development server:
bundle exec jekyll serve --livereload
-
Open in browser:
http://localhost:4000/learning_ai/
- Update project data: Edit
_data/projects.yml
- Add thumbnail: Place 300x200px image in
assets/images/
- Create project page: Copy
_templates/project-template.md
toprojects/
- Test locally: Verify everything works before committing
- Homepage (
index.md
): Project overview with thumbnails - Projects (
projects/
): Individual project pages - Team (
team.md
): Team member profiles - Onboarding (
onboarding.md
): Contributor guide - Events (
events.md
): Activities and workshops - Publications (
publications.md
): Research and papers - Contact (
contact.md
): Contact info and legal notices
- Theme: Leap Day (GitHub Pages theme)
- Jekyll Configuration:
_config.yml
- Dependencies:
Gemfile
- Data Files:
_data/
directory - Templates:
_layouts/
and_templates/
Detailed instructions are available in workflow.md, including:
- Local Jekyll setup
- Adding projects and content
- Testing and deployment
- Troubleshooting common issues
Edit _config.yml
to modify:
- Site title and description
- Repository URLs
- Navigation menu
- Build settings
Edit _data/team.yml
:
- name: "Member Name"
role: "Role/Position"
photo: "member-photo.jpg"
Update the navigation
section in _config.yml
:
navigation:
- title: "Page Title"
url: "/page-url/"
- Project Thumbnails: 300x200px, saved in
assets/images/
- Team Photos: 150x150px (square), saved in
assets/images/
- Placeholders: Available for new projects and team members
The site uses the Leap Day theme with custom CSS additions. Modify layouts in _layouts/
or add custom styles to page frontmatter.
The site is automatically deployed to GitHub Pages when changes are pushed to the main branch. The deployment source is set to the /docs
folder.
Live Site: https://csorbakristof.github.io/learning_ai/
For issues with the website:
- Check the workflow documentation
- Review Jekyll and GitHub Pages documentation
- Create an issue in the main repository
See the main project's onboarding guide for general contribution guidelines. For website-specific contributions:
- Follow the project template format
- Test changes locally before submitting
- Update documentation when adding new features
- Maintain consistency with existing design and structure
For detailed development instructions, see workflow.md