This is a brief guide to managing content with the Academic theme. Content can include homepage sections, publications, projects, 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.
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
To display an image in publication, post, or project page headers, you can include the
image = "my-image.jpg" option in the page
+++ preamble. It is automatically assumed that the image is located in your
static/img/ folder. In the context of posts and projects, the image is intended to behave as a full width banner across the top of the article.
The example site includes the following widgets which display as sections on the homepage:
- Selected publications
- Recent publications
- Recent news/blog posts
- Example custom widget called teaching
Add a section to the homepage
You can use the custom widget to create your own home page sections.
Simply duplicate (copy/paste) and rename the example teaching file at
content/home/teaching.md. Then edit the section title, weight (refer to Ordering sections below), and content as desired.
You may also wish to add a navigation link to the top of the page that points to the new section. This can be achieved by adding something similar to the following lines to your
config.toml, where the URL will consist of the first title word in lowercase:
[[menu.main]] name = "Research" url = "#research" weight = 10
Remove a section from the homepage
Note that homepage widgets for publications, projects and posts will automatically hide when there is no content of the respective type.
Otherwise, if you do not require a particular widget, you can simply delete any associated files from the
To remove a navigation link from the top of the page, remove the associated
[[menu.main]] entry in
The order that the homepage sections are displayed in is defined by the
weight parameter in each of the files in the
content/home/ directory. The sections are displayed in ascending order of their
weight, so you can simply edit the
weight parameters as desired.
Create a publication
To create a new publication:
hugo new publication/my-paper-name.md
Then edit the default variables at the top of
content/publication/my-paper-name.md to include the details of your publication. The
url_ variables are used to generate links associated with your publication, such as for viewing PDFs of papers. Here is an example:
+++ abstract = "An abstract..." authors = ["First author's name", "Second author's name"] date = "2013-07-01" image = "" image_preview = "" math = false publication = "The publishing part of the citation goes here. You may use *Markdown* for italics etc." title = "A publication title, such as title of a paper" url_code = "" url_dataset = "" url_pdf = "pdf/my-paper-name.pdf" url_project = "" url_slides = "" url_video = "" +++ Further details on your publication can be written here using *Markdown* for formatting. This text will be displayed on the Publication Detail page.
url_ links can either point to local or web content. Associated local publication content, such as PDFs, may be copied to a
static/pdf/ folder and referenced like
url_pdf = "pdf/my-paper-name.pdf".
You can also associate custom link buttons with the publication by adding the following block(s) within the variable preamble above, which is denoted by
[[url_custom]] name = "Custom Link" url = "http://www.example.org"
If you enabled
detailed_list for publications in
config.toml, then there are a few more optional variables that you can include in the publication page preamble. You may use
abstract_short = "friendly summary of abstract" and
publication_short = "abbreviated publication details" to display a friendly summary of the abstract and abbreviate the publication details, respectively. Furthermore, there is the option to display a different image on the homepage to the publication detail page by setting
image_preview = "my-image.jpg". This can be useful if you wish to scale down the image for the homepage or simply if you just wish to show a different image for the preview.
Post an article
To create a blog/news article:
hugo new post/my-article-name.md
Then edit the newly created file
content/post/my-article-name.md with your full title and content.
Hugo will automatically generate summaries of posts that appear on the homepage. If you are dissatisfied with an automated summary, you can either limit the summary length by appropriately placing
<!--more--> in the article body, or completely override the automated summary by adding a
summary parameter to the
+++ preamble such that:
summary = "Summary of my post."
To disable commenting for a specific post, you can add
disable_comments = true to the post
+++ preamble. Or to disable commenting for all posts, you can either set
disqusShortname = "" or
disable_comments = true in
Create a project
To create a project:
hugo new project/my-project-name.md
Then edit the newly created file
content/project/my-project-name.md. Either you can link the project to an external project website by setting the
external_link = "http://external-project.com" variable at the top of the file, or you can add content (below the final
+++) in order to render a project page on your website.
Generally, to remove content, simply delete the relevant file from your
View your updated site
After you have made changes to your site, you can view it by running the
hugo server --watch command and then opening localhost:1313 in your web browser.
Deploy your site
Finally, you can build the static website to a
public/ folder ready for deployment using the
You may then deploy your site by copying the
public/ directory (by FTP, SFTP, WebDAV, Rsync, git push, etc.) to your production web server.
Note that running
hugo does not remove any previously generated files before building. Therefore, it’s best practice to delete your
public/ directory prior to running
hugo to ensure no old or interim files are deployed to your server.