Skip to content

aayamrajshakya/ceamls-journal

CEAMLS SAIRI Summer Site – User Guide

Welcome! This repository hosts your personal research site built on Jekyll + Minimal theme. Below you’ll find everything you need to:

  • Add new daily blog posts
  • Edit your About Me, About My Mentors, and About My Project pages
  • Manage images and assets
  • Tweak your configuration (_config.yml)
  • Run & deploy locally or to GitHub Pages

📂 Project Structure

├── _config.yml           ← Site settings
├── _layouts/             ← Custom layouts (default, post, mentor, about, project, home)
├── _posts/               ← Daily blog posts (YYYY-MM-DD-slug.md)
├── pages/                ← Standalone pages (about-*.md, my-blog.md, index.md)
├── assets/
│   ├── css/style.scss    ← Your custom SCSS overrides
│   └── images/           ← Store profile, mentor, project, blog images here
└── README.md             ← This guide

⚙️ Configuration (_config.yml)

Open _config.yml and set:

title: "YOUR NAME"  
description: "CEAMLS SAIRI Summer 2025 Research Site"  
remote_theme: pages-themes/[email protected]  
plugins:
  - jekyll-remote-theme
future: true            

📝 Adding a New Blog Post

  1. Create a file in _posts/ named YYYY-MM-DD-day-N.md (e.g. 2025-06-12-day-6.md).
  2. Add Front Matter:
---
layout: post
title: "Day N – YOUR TITLE"
date: YYYY-MM-DD
author: YOUR NAME
---
  1. Write your post content following the structure below:
### What I Learned
-### Blockers
-### Reflection
I feel…

✍️ Editing About Pages

Standalone pages live in pages/. Each uses a layout:

  • About Melayout: about
  • About My Mentorslayout: mentor
  • About My Projectlayout: project

Example about-me.md

---
layout: about
title: About Me
permalink: /about-me.html

about:
  name: Aayam Raj Shakya
  role: Senior, Computer Science major at Mississippi State University
  image: /assets/images/aayam.png
  linkedin: https://www.linkedin.com/in/aayamrajshakya/
  bio: |
    I’m currently a senior studying Computer Science...
---

🖼️ Managing Images

  • Put images in assets/images/
  • Reference with:
<img src="{{ '/assets/images/example.jpg' | relative_url }}" alt="Example">

💅 Custom Styles

Use assets/css/style.scss:

---
---
@import "{{ site.theme }}";

/* Your styles here */
.profile-card { /* ... */ }
.blog-toc a { /* ... */ }

🚀 Running Locally

bundle install
bundle exec jekyll serve --livereload

Preview at http://localhost:4000


📤 Deployment

Just push to main. GitHub Pages will build your site automatically.


🔎 Tips

  • Images: Store in assets/images.
  • Blog TOC: Posts are grouped into weeks automatically.
  • Layouts: Add new layouts in _layouts/, use them via layout: in the front matter.
  • Front Matter: Always include correct date: so posts sort and display properly.

Enjoy writing and sharing your research journey! 📚💼

About

CEAMLS SAIRI 2025 Journal

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks