Skip to content

README.md

Latest commit

 

History

History
124 lines (96 loc) · 4.65 KB

README.md

File metadata and controls

124 lines (96 loc) · 4.65 KB
Raw

jingweizuo.com

Personal academic website for Jingwei Zuo, Principal Researcher at TII.

Static HTML + CSS + JS. Blog uses a lightweight Python build step (Markdown + LaTeX → HTML).

Local Preview

Open index.html in any browser — no server required.

Or use a local server for proper path resolution:

# Python
cd site && python3 -m http.server 8000

# Node
npx serve site

How to Edit

Update bio or personal info

Edit the <section id="about"> block in index.html.

Add a project

  1. All-projects page: Add a new <article class="project-card"> inside .projects-list in projects/index.html. Follow the existing pattern (image left, text right, pill links).
  2. Homepage (optional): If the project should be featured on the homepage, also add a card to index.html. The homepage shows only a curated subset; the full list lives at projects/index.html.
  3. Project page: Copy projects/falcon-h1.html as a template. Replace the title, authors, venue, links, summary, figures, highlights, and BibTeX.
  4. Image: Add an 800×400 hero image to images/projects/ and reference it in both the card and the project page.

Add a publication

  1. Find the correct year group in <section id="publications"> in index.html.
  2. Add a new .pub-item div following the existing format.
  3. If the year doesn't exist yet, add a new .publications-year block.

Add a blog post

  1. Create a new .md file in blog/posts/ named YYYY-MM-DD-slug.md.
  2. Add YAML frontmatter at the top: 
    ---
title: "Your Post Title"
date: 2026-03-13
summary: "One-line description for the listing page."
tags: [Tag1, Tag2]
---
  3. Write content in Markdown. Use $...$ for inline math and $$...$$ for display math (rendered by KaTeX). Use fenced code blocks for syntax-highlighted code.
  4. Run the build script: 
    pip3 install markdown pyyaml pygments   # one-time setup
python3 build_blog.py
  5. This generates blog/<slug>.html and updates blog/index.html.
  6. To show the Blog link in the navbar, uncomment it in index.html.

Add a news item

  1. Add a new .news-item div at the top of .news-list in index.html.
  2. The first 5 items are visible; items beyond that need the hidden class.
  3. Add <span class="badge-new">NEW</span> for recent items.

Replace placeholder images

Each placeholder is a <div class="placeholder-img"> with a gradient background and an HTML comment above it indicating the source URL. Replace with:

<img src="images/projects/falcon-h1.png" alt="Falcon-H1 architecture diagram">

The avatar placeholder in the hero section should be replaced similarly:

<img src="images/avatar.jpg" alt="Jingwei Zuo">

(Remove the <span class="initials">JZ</span> when replacing.)

Deploy

GitHub Pages

Push to a repo named jingweizuo.github.io. The CNAME file handles the custom domain. The .nojekyll file disables Jekyll processing.

Netlify

Connect the repo to Netlify. Set publish directory to site/ (or root if files are moved up). No build command needed.

Structure

site/
├── index.html              ← Homepage (6 sections, 4 featured projects)
├── projects/
│   ├── index.html          ← All-projects listing page (7 projects)
│   ├── falcon-h1.html      ← Fully built project page (template)
│   ├── falcon-h1-tiny.html ← Skeleton
│   ├── falcon-edge.html    ← Skeleton
│   ├── falcon-3.html       ← Skeleton
│   ├── falcon-mamba.html   ← Skeleton
│   ├── learnable-multiplier.html ← Skeleton
│   └── e2lm.html           ← Skeleton
├── blog/
│   ├── posts/              ← Markdown source files (not served)
│   │   └── 2026-03-13-attention-math.md
│   ├── index.html          ← Blog listing page (generated)
│   ├── attention-math.html ← Individual post (generated)
│   └── images/             ← Blog post images
├── build_blog.py           ← Blog build script (Markdown+LaTeX → HTML)
├── css/
│   ├── style.css           ← All styles
│   └── pygments.css        ← Syntax highlighting (generated)
├── js/
│   ├── main.js             ← Nav toggle, news expand, scroll spy
│   └── blog.js             ← TOC sidebar, sticky title, reading progress
├── images/
│   ├── avatar.jpg          ← Replace with headshot
│   └── projects/           ← Project hero images (800×400)
├── posts/                  ← PDFs or documents
├── CNAME                   ← www.jingweizuo.com
├── .nojekyll
└── README.md