Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.59 KB

README.md

File metadata and controls

64 lines (42 loc) · 3.59 KB

academic-homepage

Preview

pages-build-deployment W3C Validation Hits GitHub stars GitHub forks

A GitHub Pages (Jekyll) template for personal academic website. Click here to see the demo.

User Community

🤗 Feel free to tell us if you are using this template for your website by creating an issue here.

Need Help?

If you run into any issues while using this template, or have suggestions for improvements, please don't hesitate to create an issue here.

Getting Started

  1. First, fork this repository or click the "Use this template" button to create a new repository. The name of the repository should be <your-github-username>.github.io (click here to learn more about naming a GitHub Pages repository).
    • If you plan to customize the functionality or style of the template, and do not want to get updates from this repository, choose "Use this template".
    • If you plan to only edit the content (biography, publications, news, etc.), and would like to get updates from this repository, choose "Fork".
    • If you want to contribute to this project, fork the repository and submit a pull request.

Running Locally (Debug & Preview)

  1. Follow the step 1 and step 2 of the instruction here to install prerequisites and jekyll.

  2. Clone your forked repository to your local machine.

  3. Run the following command in the root directory of the repository:

    bundle exec jekyll serve
  4. Browse to the displayed URL to see the website.

Deploying to GitHub Pages

  1. Go to the repository settings and enable GitHub Pages. Detailed instructions can be found here.

  2. Navigate to your created website, and follow the instructions displayed on the homepage (if any) to finalize the setup.