Go to file
George Cushen 1d6e6e629e add scripts 2019-02-20 17:55:45 +00:00
config/_default upgrade content for v4.1 dev 2019-02-19 18:09:28 +00:00
content upgrade content for v4.1 dev 2019-02-19 18:09:28 +00:00
scripts add scripts 2019-02-20 17:55:45 +00:00
static/img theme: update and upgrade to Academic v4 dev 2019-01-20 13:08:23 +00:00
themes upgrade content for v4.1 dev 2019-02-19 18:09:28 +00:00
.editorconfig Add editor config 2017-12-03 19:11:36 +00:00
.gitignore Initial commit 2017-11-23 01:41:58 +00:00
.gitmodules Initial commit 2017-11-23 01:41:58 +00:00
LICENSE.md Initial commit 2017-11-23 01:41:58 +00:00
README.md chore: update demo URL in Readme 2019-01-29 15:11:32 +00:00
academic.Rproj add RStudio project file for R users 2019-01-30 01:43:03 +00:00
netlify.toml chore: move Netlify ENV to global so it's not just applied to prod 2019-01-29 15:10:58 +00:00
update_academic.sh add scripts 2019-02-20 17:55:45 +00:00
view.sh add scripts 2019-02-20 17:55:45 +00:00

README.md

Academic Kickstart

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 or view the documentation.

Academic Kickstart provides a minimal template to kickstart your new website by following the simple steps below.

Screenshot

Getting Started

The following two methods describe how to install in the cloud using your web browser and how to install on your PC using the Command Prompt/Terminal app.

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 on your PC

Prerequisites:

  1. Clone (or Fork or download) the Academic Kickstart repository 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.

  2. Initialize the theme:

    cd My_Website
    git submodule update --init --recursive
    
  3. View your new website:

    hugo server
    

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

  4. Read the Quick Start Guide to learn how to add Markdown content, customize your site, and deploy it.

License

Copyright 2017 George Cushen.

Released under the MIT license.

Analytics