mirror of https://github.com/gcushen/hugo-academic.git synced 2025-07-26 03:00:50 +02:00

No description

Find a file

Stephan Kulla fe05501b9a Improvement for social icons in about.html (#41 ) * Apply aria-hidden to the whole list of social icons since it also affects all descendants. Thus, the code becomes a bit shorter. See http://stackoverflow.com/a/18933265 for more details. * Shorten code for including social icons. This way icon packs which are included via `custom_css` are also supported. Signed-off-by: Stephan Kulla <git.mail@kulla.me>		2016-09-30 11:43:08 +01:00
archetypes	Update home archtype for new homepage widgets	2016-09-24 19:42:53 +01:00
exampleSite	Refactor homepage sections as dedicated widgets in `content/home/`.	2016-09-24 18:22:47 +01:00
images	Update packaging	2016-05-07 02:00:31 +01:00
layouts	Improvement for social icons in about.html (#41 )	2016-09-30 11:43:08 +01:00
static	css: Add responsive text scaling and general improvements	2016-09-25 05:01:38 +01:00
.editorconfig	Update .editorconfig style guide	2016-09-22 01:51:44 +01:00
LICENSE.md	Initial commit	2016-04-27 12:26:40 +01:00
README.md	Edit README	2016-09-22 02:13:59 +01:00
theme.toml	Bump minimum version of Hugo to 0.16 for upcoming improvements	2016-09-22 02:08:37 +01:00

README.md

Hugo Academic

A personal academic website theme for Hugo.

Key features:

Designed for academic staff, students, or general personal use
Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact sections
Write in Markdown for easy formatting and code highlighting, with LaTeX for mathematical expressions
Academic linking (Scholar etc.), Google Analytics, and Disqus comments
Responsive and mobile friendly
Simple and refreshing one page design
Easy to customize

Latest demo: gcushen.github.io/hugo-academic-demo/

Installation

Install Hugo and create a new website:

 hugo new site my_website
 cd my_website

Install Academic theme 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.
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/* .
```
Start the Hugo server from your website root folder:
```
 hugo server --watch
```
Now you can go to localhost:1313 and your new Academic themed website should appear.
Customize your website (see next section), build it by running hugo, and deploy it by copying the public/ directory (by FTP, Rsync, git push, etc.) to your production web server.

Getting Started

Refer to the documentation under the Posts section of the latest Academic theme demo.

Upgrading

Feel free to star the project on Github and monitor the commits for updates.

Before upgrading the theme, it is recommended to make a backup of your entire website directory, or at least your themes/academic directory. You can also read about the most recent milestones (but this doesn't necessarily reflect the latest master release).

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.

Contributing

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

License

Released under the MIT license.