hugo-academic-mirror/README.md

129 lines
8.3 KiB
Markdown
Raw Normal View History

2018-10-10 01:58:38 +01:00
<p align="center"><a href="https://sourcethemes.com/academic/" target="_blank" rel="noopener"><img src="https://sourcethemes.com/academic/img/logo_200px.png" alt="Academic logo"></a></p>
2018-01-04 01:54:24 +00:00
# Academic: the website designer for [Hugo](https://gohugo.io)
2016-04-27 12:26:40 +01:00
2018-10-10 01:58:38 +01:00
**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](https://sourcethemes.com/academic/docs/install/) to learn how to build your own free website with Academic. [Check out the personal demo](https://academic-demo.netlify.com/) or the [business demo](https://sourcethemes.com/academic/) of what you'll get in less than 10 minutes.
2018-10-10 01:58:38 +01:00
- [View the documentation](https://sourcethemes.com/academic/docs/)
- [Ask a question](http://discuss.gohugo.io/)
- [Request a feature or report a bug](https://github.com/gcushen/hugo-academic/issues)
- Updating? View the [Update Guide](https://sourcethemes.com/academic/docs/update/) and [Release Notes](https://sourcethemes.com/academic/updates/)
- Support development of Academic:
- [Donate a coffee](https://paypal.me/cushen)
2018-11-02 22:29:10 +00:00
- [Become a backer on Patreon](https://www.patreon.com/cushen)
2018-10-10 01:58:38 +01:00
- [Decorate your laptop or journal with an Academic sticker](https://www.redbubble.com/people/neutreno/works/34387919-academic)
- [Wear the T-shirt](https://academic.threadless.com/)
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
2018-10-10 01:58:38 +01:00
**Key features:**
2019-03-04 01:03:54 +00:00
- **Page builder** - Create *anything* with [**widgets**](https://sourcethemes.com/academic/docs/page-builder/) and [**elements**](https://sourcethemes.com/academic/docs/writing-markdown-latex/)
- **Edit any type of content** - Blog posts, publications, talks, slides, projects, and more!
- **Create content** in [**Markdown**](https://sourcethemes.com/academic/docs/writing-markdown-latex/), [**Jupyter**](https://sourcethemes.com/academic/docs/jupyter/), or [**RStudio**](https://sourcethemes.com/academic/docs/install/#install-with-rstudio)
- **Plugin System** - Fully customizable [**color** and **font themes**](https://sourcethemes.com/academic/themes/)
- **Display Code and Math** - Code highlighting and [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics) supported
- **Integrations** - [Google Analytics](https://analytics.google.com), [Disqus commenting](https://disqus.com), 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
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.
| `default` | `ocean` | `forest` | `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) | ![forest theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-forest.png) | ![dark theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-dark.png) |
2017-10-04 01:05:21 +01:00
| `apogee` | `1950s` | `coffee` | `cupcake` |
| --- | --- | --- | --- |
| ![apogee theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-apogee.png) | ![1950s theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-1950s.png) | ![coffee theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-coffee-playfair.png) | ![cupcake theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-cupcake.png) |
## Ecosystem
2018-11-11 01:40:19 +00:00
* **[Academic Admin](https://github.com/sourcethemes/academic-admin):** An admin tool to import publications from BibTeX or import assets for an offline site
* **[Academic Scripts](https://github.com/sourcethemes/academic-scripts):** Scripts to help migrate content to new versions of Academic
2018-01-04 01:54:24 +00:00
## Install
2016-04-27 12:26:40 +01:00
2018-01-04 01:54:24 +00:00
You can choose from one of the following four methods to install:
2018-01-20 15:11:28 +00:00
2018-01-04 01:54:24 +00:00
* 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
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://academic-demo.netlify.com/)
2016-04-27 12:26:40 +01:00
2018-01-04 01:54:24 +00:00
### Install with Git
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
2018-01-04 01:54:24 +00:00
1. [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) the *Academic Kickstart* repository and clone your fork with Git:
2017-11-24 02:25:31 +00:00
git clone https://github.com/sourcethemes/academic-kickstart.git My_Website
2018-01-04 01:54:24 +00:00
*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.*
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
2018-01-04 01:54:24 +00:00
### Install with ZIP
2017-11-24 02:25:31 +00:00
2018-01-04 01:54:24 +00:00
1. [Download](https://github.com/sourcethemes/academic-kickstart/archive/master.zip) and extract *Academic Kickstart*
2. [Download](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract the *Academic theme* to the `themes/academic/` folder from the above step
2016-04-27 12:26:40 +01:00
2018-01-04 01:54:24 +00:00
### Install with RStudio
2018-01-04 01:54:24 +00:00
[View the guide to installing Academic with RStudio](https://sourcethemes.com/academic/docs/install/#install-with-rstudio)
2016-04-27 12:26:40 +01:00
2018-01-04 01:54:24 +00:00
## Quick start
2016-05-13 00:50:16 +01:00
2018-01-04 01:54:24 +00:00
1. If you installed on your computer, view your new website by running the following command:
hugo server
2016-05-13 00:50:16 +01:00
2018-01-04 01:54:24 +00:00
Now visit [localhost:1313](http://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](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://academic-demo.netlify.com/)
2016-05-13 00:50:16 +01:00
2018-01-04 01:54:24 +00:00
3. 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 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).
2016-05-13 00:50:16 +01:00
2018-01-04 01:54:24 +00:00
## Updating
2016-05-13 00:50:16 +01:00
2019-03-04 01:03:54 +00:00
[View the Update Guide](https://sourcethemes.com/academic/docs/update/).
2016-05-13 00:50:16 +01:00
2019-03-04 01:03:54 +00:00
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) to help keep track of [updates](https://sourcethemes.com/academic/updates).
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
2018-01-04 01:54:24 +00:00
For support, head over to the [Hugo discussion forum](http://discuss.gohugo.io).
2016-10-18 03:15:55 +01:00
2016-05-07 02:00:31 +01:00
## License
2018-01-04 01:54:24 +00:00
Copyright 2016-present [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)