Bez popisu

George Cushen fa5de9234d feat(profile): support [[params.social]] links to homepage sections před 6 roky
.github 4856bfedef Add PR template před 7 roky
archetypes e9597c72c7 feat(archetype): add `hugo new` template for docs/tutorial layout před 6 roky
assets 8d8cddfdb2 Load MathJax config without eval() (#735) před 6 roky
data bc04138f61 Bump version před 6 roky
exampleSite fa5de9234d feat(profile): support [[params.social]] links to homepage sections před 6 roky
i18n b7c4001ab0 fix(i18n): add missing German translations (#739) před 6 roky
images 34deeedb07 feat(theme): add Apogee and Cupcake themes před 6 roky
layouts fa5de9234d feat(profile): support [[params.social]] links to homepage sections před 6 roky
static 5440c0eb11 fix(js): linking to a homepage section from another page před 6 roky
.editorconfig f752b362f0 staticref shortcode: Fix formatting by removing whitespace (Fix #295) před 7 roky
.gitignore 6faf695727 Add slides feature před 6 roky
LICENSE.md ca7f604f2e license: Update year před 6 roky
README.md 34deeedb07 feat(theme): add Apogee and Cupcake themes před 6 roky
academic.png 0cdbb23c1c Update Readme před 8 roky
demo.sh 6ef19085d4 Refactor most absolute URLs to relative URLs před 6 roky
theme.toml 8cea142b81 projects: Support featured image with automatic resizing před 6 roky

README.md

Academic logo

Academic: the website designer for Hugo

Academic makes it easy to create a beautiful website for free using Markdown. Customize anything on your site with widgets, themes, and language packs.

Follow our easy step by step guide to learn how to build your own free website with Academic. Check out the personal demo or the business demo of what you'll get in less than 10 minutes.

Screenshot

Key features:

  • Easily manage various content including homepage, blog posts, publications, talks, slides, and projects
  • Extensible via color themes and widgets/plugins
  • 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 forest dark
default theme ocean theme forest theme dark theme
apogee 1950s coffee cupcake
apogee theme 1950s theme coffee theme cupcake theme

Ecosystem

Academic Admin: An admin tool to import publications from BibTeX or import assets for an offline site

Install

You can choose from one of the following four methods to install:

  • one-click install using your web browser (recommended)
  • install on your computer using Git with the Command Prompt/Terminal app
  • install on your computer by downloading the ZIP files
  • install on your computer with RStudio

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 with Git

Prerequisites:

  1. Fork the Academic Kickstart repository and clone your fork 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, i.e. replace sourcethemes with your GitHub username.

  2. Initialize the theme:

    cd My_Website git submodule update --init --recursive

Install with ZIP

  1. Download and extract Academic Kickstart
  2. Download and extract the Academic theme to the themes/academic/ folder from the above step

Install with RStudio

View the guide to installing Academic with RStudio

Quick start

  1. If you installed on your computer, view your new website by running the following command:

    hugo server

    Now visit localhost:1313 and your new Academic powered website will appear. Otherwise, if using Netlify, they will provide you with your URL.

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

  3. Build your site by running the hugo command. Then host it for free using Github Pages or Netlify (refer to the first installation method). Alternatively, copy the generated public/ directory (by FTP, Rsync, etc.) to your production web server (such as a 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 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.

Feedback & Contributing

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

For support, head over to the Hugo discussion forum.

License

Copyright 2016-present George Cushen.

Released under the MIT license.

Analytics