/hugo-academic

The personal website framework for Hugo

Primary LanguageHTMLMIT LicenseMIT

Academic: the personal website framework for Hugo

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.

Screenshot

Key features:

  • Easily manage your homepage, blog posts, publications, talks, and projects
  • Configurable widgets available for Biography, Publications, Projects, News/Blog, Talks, and Contact
  • Need a different section? Just use the Custom widget!
  • Write in Markdown for easy formatting and code highlighting, with LaTeX for mathematical expressions
  • Social/academic network linking, Google Analytics, and Disqus comments
  • Responsive and mobile friendly
  • Simple and refreshing one page design
  • Multilingual and easy to customize

Color Themes

Academic is available in different color themes and font themes.

default ocean dark
default theme ocean theme dark theme
forest coffee + playfair font 1950s
forest theme coffee theme 1950s 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/sourcethemes/academic-kickstart.git My_Website

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

  2. Initialize the theme:

    cd My_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. Read the Quick Start Guide to learn how to add Markdown content, customize your site, and deploy it. For inspiration, refer to the Markdown content which powers the Demo

  5. Build your site by running the hugo command. Then host it for free using Github Pages or Netlify (refer to above section). Alternatively, copy the generated public/ directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service).

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 Academic, it is recommended to make a backup of your entire website directory, or at least your themes/academic directory.

Before updating for the first time, the remote origin repository should be renamed to upstream:

$ cd themes/academic
$ git remote rename origin upstream

To list available updates:

$ cd themes/academic
$ git fetch upstream
$ git log --pretty=oneline --abbrev-commit --decorate HEAD..upstream/master

Then, update by running:

$ git pull upstream

If you have modified files in themes/academic, git will attempt to auto-merge changes. If conflicts are reported, you will need to manually edit the files with conflicts and add them back (git add <filename>).

If there are any issues after updating, you may wish to compare your site with the latest example site to check if any settings changed in config.toml or the +++ frontmatter of content files.

Feedback & Contributing

Please use the issue tracker to let me know about any bugs or feature requests, or alternatively make a pull request.

For general questions about Hugo, there is a Hugo discussion forum.

License

Copyright 2017 George Cushen.

Released under the MIT license.

Analytics