davidraba / hugo-academic

The website builder for Hugo. Build and deploy a beautiful website in minutes :rocket:

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.

• View the documentation
• Ask a question
• Request a feature or report a bug
• Updating? View the Update Guide and Release Notes
• Support development of Academic:
  • Donate a coffee
  • Become a backer on Patreon
  • Decorate your laptop or journal with an Academic sticker
  • Wear the T-shirt

Key features:

• Page builder - Create anything with widgets and elements
• Edit any type of content - Blog posts, publications, talks, slides, projects, and more!
• Create content in Markdown, Jupyter, or RStudio
• Plugin System - Fully customizable color and font themes
• Display Code and Math - Code highlighting and LaTeX math supported
• Integrations - Google Analytics, Disqus commenting, Maps, Contact Forms, and more!
• Beautiful Site - Simple and refreshing one page design
• Industry-Leading SEO - Help get your website found on search engines and social media
• Media Galleries - Display your images and videos with captions in a customizable gallery
• Mobile Friendly - Look amazing on every screen with a mobile friendly version of your site
• Multi-language - 15+ language packs including English, 中文, and Português
• Multi-user - Each author gets their own profile page
• Privacy Pack - Assists with GDPR
• Stand Out - Bring your site to life with animation, parallax backgrounds, and scroll effects

Color Themes

Academic is available in different color themes and font themes.

default	ocean	forest	dark

apogee	1950s	coffee	cupcake

Ecosystem

• Academic Admin: An admin tool to import publications from BibTeX or import assets for an offline site
• Academic Scripts: Scripts to help migrate content to new versions of Academic

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:

• Download and install Git
• Download and install Hugo

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

View the Update Guide.

Feel free to star the project on Github to help keep track of updates.

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.