weiji14.github.io

My academic personal website and Curriculum Vitae. Built using Eleventy!

Getting Started

How to replicate a static site like this for the technical minded! The site is automatically built using Github Actions and hosted on Github Pages for free. To get things running locally, you can fork the repo first and follow the steps below.

Clone the repo

Start by cloning this repo-url, or that of your own fork.

git clone <repo-url>

Install the eleventy static site generator

npm install -g @11ty/eleventy

Build html files with eleventy

# Change directory into the repo folder
cd weiji14.github.io
# Use eleventy to build from `.` directory to `_site`
npx @11ty/eleventy

Preview the files locally

npx @11ty/eleventy --serve

Deploy to the web

The static *.html files will be located inside the _site folder. Under normal circumstances, you only need to git push the *.md files, as the Github Actions workflow in .github/workflows/eleventy_build.yml will handle the *.md to *.html conversion, and publish the _site folder up onto Github Pages. However, you may need to tell Github Pages to use the gh-pages branch as the publishing source.

Alternatively, you can upload the files in _site manually to the gh-pages branch, or another hosting provider of your choice such as netlify or Vercel.

Content structure

The content are organized into multiple pages as follow:

• Home
• Curriculum Vitae
• Experiences:
  • Community
  • Academic
  • Professional

These are list of YAML metadata tags used for each markdown (*.md) file:

• Common fields

  • date / date_start, date_end
  • image:
    • caption
    • teaser
    • thumbnail
  • websites

• Community

  • title
  • conference
  • location
  • type
    • workshop

• Academic

  • title
  • authors
  • conference
  • publication
  • location
  • citation
  • type
    • preprint/paper/thesis
    • presentation
    • poster

• Professional

  • role
  • team
  • company