Skip to content

avi-xd/Aviral

Repository files navigation

A clean, minimal website showcasing research projects and academic work. Built with Jekyll and inspired by Frank Chimero's elegant typography-focused design principles.

Design Philosophy

This website follows a Frank Chimero-inspired design:

Design Inspiration: frankchimero.com

Prerequisites

  • Ruby (3.0+)
  • RubyGems
  • Bundler

Installation

  1. Clone the repository

    git clone https://github.com/avi-xd/Aviral.git
    cd Aviral_single_page
  2. Install dependencies

    bundle config set --local path 'vendor/bundle'
    bundle install
  3. Run the development server

    bundle exec jekyll serve --host 0.0.0.0 --port 4000
  4. Access your site

    http://localhost:4000/Avi_web/
    

📁 Project Structure

📦 Aviral_single_page/
├── 📄 _config.yml          # Site configuration
├── 📄 index.html           # Main single-page layout
├──  css/main.scss        # Custom styles (Frank Chimero-inspired)
├── 📂 _layouts/
│   ├── 📄 project.html     # Individual project page template
│   └── 📄 single-page.html # Main site layout
├── 📂 _projects/           # Project markdown files
│   ├── 📄 magnon-visualisation-system.md
│   ├── 📄 high-tc-superconductors.md
│   ├── 📄 electronic-properties-superconductors.md
│   ├── 📄 ml-holographic-microscopy.md
│   ├── 📄 quantum-computing-cirq.md
│   ├── 📄 scattering-external-potential.md
│   ├── 📄 hovhs.md
│   ├── 📄 ising-model.md
│   └── 📄 mesoscopic.md
└── 📂 images/              # Profile and project images

Customization

Adding New Projects

  1. Create a new .md file in _projects/
  2. Add frontmatter with project details:
    ---
    layout: project
    title: "Your Project Title"
    category: "Research" # or "Course Project"
    institution: "Your Institution"
    timeline: "Month Year - Month Year"
    supervisor: "Dr. Name"
    description: "Brief description"
    ---
  3. Add the project card to _layouts/single-page.html

Updating Profile Information

Edit _config.yml:

author:
  name: 'Your Name'
  email: [email protected]
  image: '/images/your-profile.jpg'

social:
  - title: "Email"
    url: "mailto:[email protected]"
  - title: "GitHub"  
    url: "https://github.com/yourusername"

Dependencies

  • Jekyll 4.4+ - Static site generator
  • MathJax - Mathematical notation rendering
  • HTML5 & CSS3 - Modern web standards
  • Flexbox & CSS Grid - Responsive layout system
  • SCSS - Enhanced CSS with variables and nesting

Contact

Aviral Verma

License

This project is licensed under the MIT License - see the LICENSE file for details.


About

Personal Website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published