hugo-academic-mirror/README.md

107 lines
6.2 KiB
Markdown
Raw Normal View History

2017-01-20 18:01:52 +00:00
# Academic: the personal website framework for [Hugo](https://gohugo.io)
2016-04-27 12:26:40 +01:00
2017-04-28 12:47:28 +01:00
**Academic** is a framework to help you create a beautiful website quickly. Perfect for personal, student, or academic websites. [Check out the latest demo](https://sourcethemes.com/academic/) of what you'll get in less than 10 minutes.
2016-04-27 12:26:40 +01:00
2017-01-29 18:52:25 +00:00
[![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/academic.png)](https://github.com/gcushen/hugo-academic/)
2016-04-27 12:26:40 +01:00
Key features:
2017-01-20 18:01:52 +00:00
- Easily manage your homepage, blog posts, publications, talks, and projects
- Configurable widgets available for Biography, Publications, Projects, News/Blog, Talks, and Contact
- Need a different section? Just use the Custom widget!
2017-11-28 23:59:13 +00:00
- Write in [Markdown](https://sourcethemes.com/academic/docs/writing-markdown-latex/) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions
2017-01-20 18:01:52 +00:00
- Social/academic network linking, [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
2016-04-27 12:26:40 +01:00
- Responsive and mobile friendly
2016-05-07 02:00:31 +01:00
- Simple and refreshing one page design
2017-09-28 01:24:08 +01:00
- Multilingual and easy to customize
2016-04-27 12:26:40 +01:00
2017-10-04 01:05:21 +01:00
## Color Themes
Academic is available in different color themes and font themes.
2017-11-28 23:59:13 +00:00
| `default` | `ocean` | `dark` |
| --- | --- | --- |
| ![default theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-default.png) | ![ocean theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-ocean.png) | ![dark theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-dark.png) |
2017-10-04 01:05:21 +01:00
| `forest` | `coffee` + `playfair` font | `1950s` |
2017-11-28 23:59:13 +00:00
| --- | --- | --- |
| ![forest theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-forest.png) | ![coffee theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-coffee-playfair.png) | ![1950s theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-1950s.png) |
2016-10-18 03:15:55 +01:00
## Getting Started
2016-04-27 12:26:40 +01:00
2017-11-24 02:25:31 +00:00
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.
2016-04-27 17:34:01 +01:00
2017-11-24 02:25:31 +00:00
### Quick install using your web browser
2016-04-27 17:34:01 +01:00
1. [Install Academic with Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/sourcethemes/academic-kickstart)
* 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](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content. For inspiration, refer to the [Markdown content](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) which powers the [Demo](https://themes.gohugo.io/theme/academic/)
2016-04-27 12:26:40 +01:00
2017-11-24 02:25:31 +00:00
### Install on your PC
2016-05-13 00:50:16 +01:00
2017-11-24 02:25:31 +00:00
Prerequisites:
2016-04-27 12:26:40 +01:00
2017-11-24 02:25:31 +00:00
* [Download and install Git](https://git-scm.com/downloads)
* [Download and install Hugo](https://gohugo.io/getting-started/installing/#quick-install)
2016-04-27 17:34:01 +01:00
2017-11-24 02:25:31 +00:00
1. Clone (or [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) or [download](https://github.com/sourcethemes/academic-kickstart/archive/master.zip)) the *Academic Kickstart* repository with Git:
git clone https://github.com/sourcethemes/academic-kickstart.git My_Website
2017-11-28 23:59:13 +00:00
*Note that if you forked Academic Kickstart, the above command should be edited to clone your fork.*
2017-11-30 09:16:25 +00:00
2. Initialize the theme:
2016-04-27 17:34:01 +01:00
2017-11-24 02:25:31 +00:00
cd My_Website
2017-11-30 09:16:25 +00:00
git submodule update --init --recursive
3. View your new website:
2017-11-24 02:25:31 +00:00
hugo server
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear.
2017-11-30 09:16:25 +00:00
4. Read the [Quick Start Guide](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content, customize your site, and deploy it. For inspiration, refer to the [Markdown content](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) which powers the [Demo](https://themes.gohugo.io/theme/academic/)
2016-04-27 12:26:40 +01:00
2017-11-30 09:16:25 +00:00
5. Build your site by running the `hugo` command. Then [host it for free using Github Pages](https://georgecushen.com/create-your-website-with-hugo/) or Netlify (refer to above section). Alternatively, copy the generated `public/` directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service).
2017-09-28 01:24:08 +01:00
## Updating
2016-04-27 12:26:40 +01:00
2017-09-28 01:24:08 +01:00
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) to help keep track of updates and check out the [release notes](https://sourcethemes.com/academic/tags/updates) prior to updating your site.
2016-05-13 00:50:16 +01:00
2017-09-28 01:24:08 +01:00
Before updating Academic, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory.
2016-05-13 00:50:16 +01:00
2017-09-28 01:24:08 +01:00
Before updating for the first time, the remote *origin* repository should be renamed to *upstream*:
2016-05-13 00:50:16 +01:00
$ cd themes/academic
$ git remote rename origin upstream
To list available updates:
$ cd themes/academic
2016-05-13 11:28:22 +01:00
$ git fetch upstream
$ git log --pretty=oneline --abbrev-commit --decorate HEAD..upstream/master
2016-05-13 00:50:16 +01:00
2017-09-28 01:24:08 +01:00
Then, update by running:
2016-05-13 00:50:16 +01:00
2016-05-31 18:36:43 +01:00
$ git pull upstream
2016-05-13 00:50:16 +01:00
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>`).
2017-09-28 01:24:08 +01:00
If there are any issues after updating, you may wish to compare your site with the latest [example site](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) to check if any settings changed in `config.toml` or the `+++` frontmatter of content files.
2016-04-27 23:53:39 +01:00
2016-10-18 03:15:55 +01:00
## Feedback & Contributing
2016-04-27 23:53:39 +01:00
Please use the [issue tracker](https://github.com/gcushen/hugo-academic/issues) to let me know about any bugs or feature requests, or alternatively make a pull request.
2016-04-27 12:26:40 +01:00
2016-10-18 03:15:55 +01:00
For general questions about Hugo, there is a [Hugo discussion forum](http://discuss.gohugo.io).
2016-05-07 02:00:31 +01:00
## License
2017-01-20 18:01:52 +00:00
Copyright 2017 [George Cushen](https://georgecushen.com).
2016-05-07 02:00:31 +01:00
Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license.
2016-10-18 03:15:55 +01:00
[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/hugo-academic/readme?pixel)](https://github.com/igrigorik/ga-beacon)