hugo-academic

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.

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
• Easy to customize

Getting Started

1. Install Hugo and create a new website by typing the following commands in your Terminal or Command Prompt app:

   hugo new site my_website
   cd my_website
   

2. Install Academic with git:

   git clone https://github.com/gcushen/hugo-academic.git themes/academic
   

   Or alternatively, download Academic and extract it into a themes/academic folder within your Hugo website.

3. If you are creating a new website, copy the contents of the exampleSite folder to your website root folder, overwriting existing files if necessary. The exampleSite folder contains an example config file and content to help you get started.

   cp -av themes/academic/exampleSite/* .
   

4. Start the Hugo server from your website root folder:

   hugo server --watch
   

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

5. Customize your website and add your content by referring to the Academic documentation

6. Build your site by running the hugo command. Then host it for free using Github Pages. Or alternatively, copy the generated public/ directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service).

Upgrading

Feel free to star the project on Github and monitor the commits for updates. Release notes for notable updates are also available to aid upgrading your site.

Before upgrading Academic, it is recommended to make a backup of your entire website directory, or at least your themes/academic directory.

Before upgrading 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, upgrade 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 upgrading, you may wish to compare your site with the latest example site to check if any settings changed.

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.