|
| 1 | +# AI Developer Portfolio & Research Blog |
| 2 | + |
| 3 | +A modern, responsive personal website for AI developers and researchers to showcase their work and paper reviews. Designed to be hosted on GitHub Pages. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Clean, modern design with responsive layout |
| 10 | +- Portfolio section with support for GIFs and videos to showcase AI projects |
| 11 | +- Detailed paper review system with support for: |
| 12 | + - Mathematical equations (MathJax) |
| 13 | + - Code snippets with syntax highlighting |
| 14 | + - Interactive elements |
| 15 | + - Tables and figures |
| 16 | +- Simple and lightweight architecture |
| 17 | +- Easy to customize and extend |
| 18 | +- Mobile-friendly |
| 19 | + |
| 20 | +## Live Demo |
| 21 | + |
| 22 | +Visit the live site: [https://yourusername.github.io](https://yourusername.github.io) |
| 23 | + |
| 24 | +## Setup Instructions |
| 25 | + |
| 26 | +### 1. Fork or Clone this Repository |
| 27 | + |
| 28 | +```bash |
| 29 | +git clone https://github.com/yourusername/yourusername.github.io.git |
| 30 | +cd yourusername.github.io |
| 31 | +``` |
| 32 | + |
| 33 | +### 2. Customize the Website |
| 34 | + |
| 35 | +- **Personal Information**: Edit `index.html` to update your name, bio, skills, and contact information |
| 36 | +- **Profile Image**: Replace the placeholder image in the About section with your own |
| 37 | +- **Projects**: Add your own projects to the Projects section, including GIFs or videos of your work |
| 38 | +- **Paper Reviews**: Create new paper review pages based on the template provided |
| 39 | + |
| 40 | +### 3. Deploy to GitHub Pages |
| 41 | + |
| 42 | +1. Create a GitHub repository named `yourusername.github.io` |
| 43 | +2. Push your customized code to this repository: |
| 44 | + |
| 45 | +```bash |
| 46 | +git add . |
| 47 | +git commit -m "Initial website setup" |
| 48 | +git remote set-url origin https://github.com/yourusername/yourusername.github.io.git |
| 49 | +git push -u origin main |
| 50 | +``` |
| 51 | + |
| 52 | +3. Go to your repository settings on GitHub |
| 53 | +4. Navigate to the "Pages" section |
| 54 | +5. Select the branch you want to deploy (usually `main`) |
| 55 | +6. Click "Save" |
| 56 | + |
| 57 | +Your website will be live at `https://yourusername.github.io` within a few minutes. |
| 58 | + |
| 59 | +## Adding New Paper Reviews |
| 60 | + |
| 61 | +1. Duplicate the `paper-review-template.html` file |
| 62 | +2. Rename it to something relevant to the paper (e.g., `transformer-attention-review.html`) |
| 63 | +3. Edit the content to add your review |
| 64 | +4. Add a link to this review in the Papers section of the main page |
| 65 | + |
| 66 | +## Customization |
| 67 | + |
| 68 | +### Colors and Styling |
| 69 | + |
| 70 | +You can customize the color scheme and styling by editing the CSS variables in `css/styles.css`: |
| 71 | + |
| 72 | +```css |
| 73 | +:root { |
| 74 | + --primary-color: #2563eb; |
| 75 | + --secondary-color: #3b82f6; |
| 76 | + /* ...other variables... */ |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +### Adding New Sections |
| 81 | + |
| 82 | +To add a new section to the website: |
| 83 | + |
| 84 | +1. Add a new section to `index.html` following the existing pattern |
| 85 | +2. Create any necessary CSS styles in `css/styles.css` |
| 86 | +3. Update the navigation menu in the header |
| 87 | + |
| 88 | +## Technologies Used |
| 89 | + |
| 90 | +- HTML5 |
| 91 | +- CSS3 (with CSS variables for theming) |
| 92 | +- JavaScript (vanilla) |
| 93 | +- MathJax (for mathematical equations) |
| 94 | +- Highlight.js (for code syntax highlighting) |
| 95 | +- Font Awesome (for icons) |
| 96 | +- Google Fonts |
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +This project is open source and available under the [MIT License](LICENSE). |
| 101 | + |
| 102 | +## Acknowledgements |
| 103 | + |
| 104 | +- [Font Awesome](https://fontawesome.com/) for icons |
| 105 | +- [Google Fonts](https://fonts.google.com/) for typography |
| 106 | +- [MathJax](https://www.mathjax.org/) for mathematical equations |
| 107 | +- [Highlight.js](https://highlightjs.org/) for code syntax highlighting |
0 commit comments