mirror of
https://github.com/gcushen/hugo-academic.git
synced 2025-07-26 03:00:50 +02:00
Update docs
This commit is contained in:
George Cushen
parent
2220cd5d95
commit
af7e88aa5f
6 changed files with 58 additions and 25 deletions
25
README.md
25
README.md
|
|
@ -1,21 +1,20 @@
|
|||
# Hugo Academic
|
||||
# Academic: the personal website framework for [Hugo](https://gohugo.io)
|
||||
|
||||
A highly flexible personal website theme for [Hugo](https://gohugo.io).
|
||||
**Academic** is a framework to help you create a beautiful website quickly. Perfect for personal, student, or academic websites. [Check out the latest demo](http://gcushen.github.io/hugo-academic-demo/) of what you'll get in less than 10 minutes.
|
||||
|
||||
[](https://github.com/gcushen/hugo-academic/)
|
||||
|
||||
Key features:
|
||||
|
||||
- Designed for academic staff, students, or general personal use
|
||||
- Configurable widgets available for Biography, Publications, Projects, News/Blog, Talks, Contact, and Custom
|
||||
- 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!
|
||||
- Write in [Markdown](http://gcushen.github.io/hugo-academic-demo/post/writing-markdown-latex/) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions
|
||||
- Academic linking (Scholar etc.), [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
|
||||
- Social/academic network linking, [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
|
||||
- Responsive and mobile friendly
|
||||
- Simple and refreshing one page design
|
||||
- Easy to customize
|
||||
|
||||
Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hugo-academic-demo/)
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. [Install Hugo](https://georgecushen.com/create-your-website-with-hugo/#installing-hugo) and create a new website by typing the following commands in your *Terminal* or *Command Prompt* app:
|
||||
|
|
@ -23,7 +22,7 @@ Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hu
|
|||
hugo new site my_website
|
||||
cd my_website
|
||||
|
||||
2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/):
|
||||
2. Install Academic with [git](https://help.github.com/articles/set-up-git/):
|
||||
|
||||
git clone https://github.com/gcushen/hugo-academic.git themes/academic
|
||||
|
||||
|
|
@ -37,17 +36,17 @@ Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hu
|
|||
|
||||
hugo server --watch
|
||||
|
||||
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic themed website should appear.
|
||||
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear.
|
||||
|
||||
5. [Customize your website](http://gcushen.github.io/hugo-academic-demo/post/getting-started/#getting-started) and [add your content](http://gcushen.github.io/hugo-academic-demo/post/managing-content/) by referring to the Academic theme documentation
|
||||
5. [Customize your website](http://gcushen.github.io/hugo-academic-demo/post/getting-started/#getting-started) and [add your content](http://gcushen.github.io/hugo-academic-demo/post/managing-content/) by referring to the Academic documentation
|
||||
|
||||
6. 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 alternatively, copy the generated `public/` directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service).
|
||||
|
||||
## Upgrading
|
||||
|
||||
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and monitor the [commits](https://github.com/gcushen/hugo-academic/commits/master) for updates.
|
||||
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and monitor the [commits](https://github.com/gcushen/hugo-academic/commits/master) for updates. [Release notes](https://github.com/gcushen/hugo-academic/wiki/Release-Notes) for notable updates are also available to aid upgrading your site.
|
||||
|
||||
Before upgrading the theme, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory. You can also read about the [most recent milestones](https://github.com/gcushen/hugo-academic/releases) (but this doesn't necessarily reflect the latest *master* release).
|
||||
Before upgrading Academic, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory.
|
||||
|
||||
Before upgrading for the first time, the remote *origin* repository should be renamed to *upstream*:
|
||||
|
||||
|
|
@ -76,7 +75,7 @@ For general questions about Hugo, there is a [Hugo discussion forum](http://disc
|
|||
|
||||
## License
|
||||
|
||||
Copyright 2016 [George Cushen](https://georgecushen.com).
|
||||
Copyright 2017 [George Cushen](https://georgecushen.com).
|
||||
|
||||
Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
+++
|
||||
title = "Posts"
|
||||
date = "2017-01-01T00:00:00Z"
|
||||
math = false
|
||||
highlight = false
|
||||
+++
|
||||
|
|
|
|||
|
|
@ -3,21 +3,22 @@ date = "2016-04-20T12:00:00"
|
|||
draft = false
|
||||
image = "banners/getting-started.png"
|
||||
tags = ["academic", "hugo"]
|
||||
title = "Getting started with the Academic theme for Hugo"
|
||||
title = "Getting started with the Academic framework for Hugo"
|
||||
math = true
|
||||
summary = """
|
||||
Create a beautifully simple academic or personal website in under 10 minutes.
|
||||
Create a beautifully simple personal or academic website in under 10 minutes.
|
||||
"""
|
||||
+++
|
||||
|
||||
The Academic theme enables you to easily create a beautifully simple academic or personal website using the [Hugo](https://gohugo.io) static site generator.
|
||||
The Academic framework enables you to easily create a beautifully simple personal or academic website using the [Hugo](https://gohugo.io) static site generator.
|
||||
|
||||
Key features:
|
||||
|
||||
- Designed for academic staff, students, or general personal use
|
||||
- Configurable widgets available for Biography, Publications, Projects, News/Blog, Talks, Contact, and Custom
|
||||
- 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!
|
||||
- Write in [Markdown]({{< ref "post/writing-markdown-latex.md" >}}) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions
|
||||
- Academic linking (Scholar etc.), [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
|
||||
- Social/academic network linking, [Google Analytics](https://analytics.google.com), and [Disqus](https://disqus.com) comments
|
||||
- Responsive and mobile friendly
|
||||
- Simple and refreshing one page design
|
||||
- Easy to customize
|
||||
|
|
@ -29,7 +30,7 @@ Key features:
|
|||
hugo new site my_website
|
||||
cd my_website
|
||||
|
||||
2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/):
|
||||
2. Install Academic with [git](https://help.github.com/articles/set-up-git/):
|
||||
|
||||
git clone https://github.com/gcushen/hugo-academic.git themes/academic
|
||||
|
||||
|
|
@ -43,7 +44,7 @@ Key features:
|
|||
|
||||
hugo server --watch
|
||||
|
||||
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic themed website should appear.
|
||||
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear.
|
||||
|
||||
5. Customize your website - refer to the *Getting Started* section below
|
||||
|
||||
|
|
@ -84,12 +85,12 @@ Refer to our guide on [managing content]({{< ref "post/managing-content.md" >}})
|
|||
|
||||
### Customization & Upgrading
|
||||
|
||||
Continue reading below for advanced customization tips and instructions for keeping the theme up-to-date with any improvements that become available.
|
||||
Continue reading below for advanced customization tips and instructions for keeping the framework up-to-date with any improvements that become available.
|
||||
|
||||
|
||||
## Advanced customization
|
||||
|
||||
It is possible to carry out many customizations without touching any files in `themes/academic`, making it easier to upgrade the theme in the future.
|
||||
It is possible to carry out many customizations without touching any files in `themes/academic`, making it easier to upgrade the framework in the future.
|
||||
|
||||
### Navigation menu
|
||||
|
||||
|
|
@ -145,7 +146,7 @@ Where `:slug` defaults to the filename of the post, excluding the file extension
|
|||
|
||||
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and monitor the [commits](https://github.com/gcushen/hugo-academic/commits/master) for updates.
|
||||
|
||||
Before upgrading the theme, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory. You can also read about the [most recent milestones](https://github.com/gcushen/hugo-academic/releases) (but this doesn't necessarily reflect the latest *master* release).
|
||||
Before upgrading the framework, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory. You can also read about the [most recent milestones](https://github.com/gcushen/hugo-academic/releases) (but this doesn't necessarily reflect the latest *master* release).
|
||||
|
||||
Before upgrading for the first time, the remote *origin* repository should be renamed to *upstream*:
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title = "Managing content"
|
|||
math = false
|
||||
+++
|
||||
|
||||
This is a brief guide to managing content with the Academic theme. Content can include publications, projects, talks, and news/blog articles. After you have read this guide about creating and managing content, you may also be interested to learn about [writing content with Markdown, LaTeX, and Shortcodes]({{< ref "post/writing-markdown-latex.md" >}}).<!--more-->
|
||||
This is a brief guide to managing content with the Academic framework. Content can include publications, projects, talks, and news/blog articles. After you have read this guide about creating and managing content, you may also be interested to learn about [writing content with Markdown, LaTeX, and Shortcodes]({{< ref "post/writing-markdown-latex.md" >}}).<!--more-->
|
||||
|
||||
To enable LaTeX math rendering for a page, you should include `math = true` in the page's `+++` preamble, as demonstrated in the included example site. Otherwise, to enable math on the homepage or for all pages, you must globally set `math = true` in `config.toml`.
|
||||
|
||||
|
|
@ -89,6 +89,30 @@ To create a talk:
|
|||
|
||||
Then edit the newly created file `content/talk/my-talk-name.md` with your full talk title and details. Note that many of the talk parameters are similar to the publication parameters.
|
||||
|
||||
## Manage node index pages
|
||||
|
||||
The node index pages (e.g. `/post/`) are the special pages which list all of your content. They can exist for blog posts, publications, and talks. The homepage widgets will automatically link to the node index pages when you have more items of content than can be displayed in the widget. Therefore, if you don't have much content, you may not see the automatic links yet - but you can also manually link to them using a normal Markdown formatted link in your content.
|
||||
|
||||
You can edit the title and add your own content, such as an introduction, by creating and editing the following content files for the node indexes:
|
||||
|
||||
hugo new post/_index.md
|
||||
hugo new publication/_index.md
|
||||
hugo new talk/_index.md
|
||||
|
||||
Then remove all parameters except for `title`, `math`, `highlight`, and `date`. Edit the `title` parameter as desired and add any content after the `+++` preamble/frontmatter ends. For example, you should have something similar to:
|
||||
|
||||
```toml
|
||||
+++
|
||||
title = "List of my posts"
|
||||
date = "2017-01-01T00:00:00Z"
|
||||
math = false
|
||||
highlight = false
|
||||
+++
|
||||
|
||||
Below is an automatically generated list of all my blog posts!
|
||||
|
||||
```
|
||||
|
||||
## Removing content
|
||||
|
||||
Generally, to remove content, simply delete the relevant file from your `content/post`, `content/publication`, `content/project`, or `content/talk` folder.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
+++
|
||||
title = "Publications"
|
||||
date = "2017-01-01T00:00:00Z"
|
||||
math = false
|
||||
highlight = false
|
||||
+++
|
||||
|
|
|
|||
|
|
@ -1,3 +1,6 @@
|
|||
+++
|
||||
title = "Recent & Upcoming Talks"
|
||||
date = "2017-01-01T00:00:00Z"
|
||||
math = false
|
||||
highlight = false
|
||||
+++
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue