Quarto Academic Website Template

Welcome! This is a simple and customizable template for building your own academic website using Quarto. You can easily fork, edit, and publish your site with just a few steps.

🚀 Quick Start

1. Star this repository to bookmark it for future reference.
2. Fork this repository and rename it to YourGitHubUserName.github.io.
3. Test to publish your site using GitHub Pages (make sure configuring your GitHub repository to publish from the docs directory, not the root folder).
4. Check if your website works or not. If successful, you should see exactly the same website as this one using your own Github Pages url:
   • https://YourGitHubUserName.github.io if your repository name is YourGitHubUserName.github.io
   • https://YourGitHubUserName.github.io/RepositoryName for other RepositoryName
   • Errors:
     • If 404, it is likely you haven't set up GitHub Pages
     • If it shows the README file, it is likely you've published from the root folder, not the docs directory

If you achieve this milestone, congratulations! You are now ready to start updating your website:

1. Update the _quarto.yml file to configure your site’s basic settings.
2. Add or edit content in the following files and folders:
   • /posts/ – posts about publications, news, events
   • teaching.qmd – teaching information
   • projects.yml – research or other projects
   • people.qmd and /people/ – team or collaborators
   • /files/ - profiles, images, pdfs, and includes
3. Render and preview your site locally.
4. Commit to publish your updates.
5. Refine and polish your content and design as needed.
6. ✅ Enjoy your new website!
7. Link your website on your official pages to let Google and AI bots include in their search results.

🛠 Requirements

• Install Quarto
• Learn the basics from the official Quarto documentation

📚 More Examples & Tips

• Quarto Academic Site Examples and Tips