/personal-website

Easily create a beautiful website using Academic and Hugo

Primary LanguageTeXMIT LicenseMIT

Academic Kickstart

Academic is a framework to help you create a beautiful website quickly. Perfect for personal, student, or academic websites. Check out the latest demo of what you'll get in less than 10 minutes or view the documentation.

Academic Kickstart provides a minimal template to kickstart your new website by following the simple steps below.

Screenshot

Color Themes

Academic is available in different color themes and font themes.

default ocean forest dark
default theme ocean theme forest theme dark theme
apogee 1950s coffee cupcake
apogee theme 1950s theme coffee theme cupcake theme

Getting Started

The following two methods describe how to install in the cloud using your web browser and how to install on your PC using the Command Prompt/Terminal app.

Quick install using your web browser

  1. Install Academic with Netlify
    • Netlify will provide you with a customizable URL to access your new site
  2. On GitHub, go to your newly created academic-kickstart repository and edit config.toml to personalize your site. Shortly after saving the file, your site will automatically update
  3. Read the Quick Start Guide to learn how to add Markdown content. For inspiration, refer to the Markdown content which powers the Demo

Install on your PC

Prerequisites:

  1. Clone (or Fork or download) the Academic Kickstart repository with Git:

    git clone https://github.com/IVUL-KAUST/personal-website

    Note that if you forked Academic Kickstart, the above command should be edited to clone your fork.

  2. Initialize the theme:

    cd personal-website
git submodule update --init --recursive

  3. View your new website:

    hugo server

    Now you can go to localhost:1313 and your new Academic powered website should appear.

  4. Your task now is to edit the files under config and content folders. Read the Quick Start Guide to learn more about how to add Markdown content, customize your site, and deploy it.

  5. TODO: Explain how to deploy it.

Updating

Feel free to star the project on Github to help keep track of updates and check out the release notes prior to updating your site.

Before updating the framework, it is recommended to make a backup of your entire website directory (or at least your themes/academic directory) and record your current version number.

By default, Academic is installed as a Git submodule which can be updated by running the following command:

git submodule update --remote --merge

Check out the update guide for full instructions and alternative methods.

License

Copyright 2017 George Cushen.

Released under the MIT license.

Analytics