بدون توضیح

George Cushen b8b6c88f60 Add `alert` shortcode 8 سال پیش
archetypes 30395f8c0b Update home archtype for new homepage widgets 8 سال پیش
exampleSite b8b6c88f60 Add `alert` shortcode 8 سال پیش
images 5a88899600 Update packaging 9 سال پیش
layouts b8b6c88f60 Add `alert` shortcode 8 سال پیش
static b8b6c88f60 Add `alert` shortcode 8 سال پیش
.editorconfig fa9a77d5fa Update .editorconfig style guide 8 سال پیش
LICENSE.md 7867f653e8 Initial commit 9 سال پیش
README.md c20a136e61 docs: Update 8 سال پیش
theme.toml a1701292c9 Bump minimum version of Hugo to 0.16 for upcoming improvements 8 سال پیش

README.md

Hugo Academic

A personal academic website theme for Hugo.

Screenshot

Key features:

  • Designed for academic staff, students, or general personal use
  • Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact widgets
  • 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/

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 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.

  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 themed website should appear.

  5. Customize your website and add your content by referring to the Academic theme 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.

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.

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 2016 George Cushen.

Released under the MIT license.

Analytics