diff --git a/exampleSite/content/post/faq.md b/exampleSite/content/post/faq.md deleted file mode 100644 index bef7af9c..00000000 --- a/exampleSite/content/post/faq.md +++ /dev/null @@ -1,50 +0,0 @@ -+++ -date = 2016-04-10 -# lastmod = 2017-09-03 -draft = false -tags = ["academic", "hugo"] -title = "Frequently Asked Questions (FAQ)" -summary = """Troubleshoot common issues.""" -+++ - -Common questions and answers will be listed here. - -**I cloned/downloaded Academic but Hugo produces errors when using it with my existing Hugo site** - -Academic is a website *framework* rather than just a *theme*. Therefore, you must follow the full installation guide found on the Demo/Documentation website or in the Github Readme. If you still have problems, first try running Hugo on the Academic Example Site found in the `themes/academic/exampleSite` folder and then compare the configuration parameters in the Example Site's `config.toml` and content files with the files in your existing site. - -**Hosting your site with Netlify or Cloudflare and experience strange behavior such as filters not working?** - -Disable post-processing steps such as *minification* in your Netlify/Cloudflare admin panel. - -**Publications and other content are not sorted by newest first** - -Hugo/TOML require that the value for the `date` field should be in [TOML format](https://github.com/toml-lang/toml#local-date-time), as per frontmatter of the `content/publication/` files in the example site. If you want to use a partial date, such as year, you should still complete a full date to make a valid TOML date format. - -**Issue parsing LaTeX in publication abstract** - -Let's consider the following LaTeX which fails to parse correctly: - - abstract = "${O(d_{\max})}$" - -This is a side effect of Academic and Hugo attempting to parse TOML, Markdown and LaTeX content in the abstract. The solution is to: - -- escape each LaTeX backslash (`\`) with an extra backslash, yielding `\\` -- escape each LaTeX underscore (`_`) with two backslashes, yielding `\\_`. - -Hence, editing the above example, we get: - - abstract = "${O(d\\_{\\max})}$" - -**Cannot achieve line break in multiline equation (LaTeX/Mathjax)** - -`\\` usually achieves a line break in a multiline LaTeX/Mathjax equation, but due to Hugo's Markdown parser it doesn't. - -Solution: use 6 backslashes for a line break, for example: - -``` -$$\begin{eqnarray} -y &=& 1+1 \\\\\\ -&=& 2 -\end{eqnarray}$$ -``` diff --git a/exampleSite/content/post/getting-started.md b/exampleSite/content/post/getting-started.md index b1061f52..5c82b0aa 100644 --- a/exampleSite/content/post/getting-started.md +++ b/exampleSite/content/post/getting-started.md @@ -1,219 +1,144 @@ +++ +title = "Academic: the website designer for Hugo" + date = 2016-04-20 -lastmod = 2017-09-03 +lastmod = 2018-01-13 draft = false -tags = ["academic", "hugo"] -title = "Getting started with the Academic framework for Hugo" -math = true -summary = """ -Create a beautifully simple personal or academic website in under 10 minutes. -""" + +tags = ["academic"] +summary = "Create a beautifully simple website or blog in under 10 minutes." [header] image = "headers/getting-started.png" caption = "Image credit: [**Academic**](https://github.com/gcushen/hugo-academic/)" +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-default.png" +caption = "Default" + +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-ocean.png" +caption = "Ocean" + +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-dark.png" +caption = "Dark" + +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-forest.png" +caption = "Default" + +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-coffee-playfair.png" +caption = "Coffee theme with Playfair font" + +[[gallery_item]] +album = "1" +image = "https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-1950s.png" +caption = "1950s" +++ -The Academic framework enables you to easily create a beautifully simple personal or academic website using the [Hugo](https://gohugo.io) static site generator. +**Academic** is a framework to help you create a beautiful website quickly. Perfect for personal sites, blogs, or business/project sites. [Check out the latest demo](https://themes.gohugo.io/theme/academic/) of what you'll get in less than 10 minutes. Then head on over to the [Quick Start guide](https://sourcethemes.com/academic/docs/) or take a look at the [Release Notes](https://sourcethemes.com/academic/updates/). + +[![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/academic.png)](https://github.com/gcushen/hugo-academic/) Key features: -- 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 +- Easily manage various content including homepage, blog posts, publications, talks, and projects +- Extensible via **color themes** and **widgets/plugins** +- 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 - 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 - Multilingual and easy to customize -{{% toc %}} +## Color Themes -## Installation +Academic is available in different color themes and font themes. -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: +{{< gallery >}} - hugo new site my_website - cd my_website +## Install -2. Install Academic with [git](https://help.github.com/articles/set-up-git/): +You can choose from one of the following four methods to install: +* 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 - git clone https://github.com/gcushen/hugo-academic.git themes/academic +### Quick install using your web browser - Or alternatively, [download Academic](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract it into a `themes/academic` folder within your Hugo website. +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/) -3. If you are creating a new website, copy the contents of the `exampleSite` folder to your website root folder, overwriting existing files if necessary. The `exampleSite` folder contains an example config file and content to help you get started. +### Install with Git - cp -av themes/academic/exampleSite/* . +Prerequisites: -4. Start the Hugo server from your website root folder: +* [Download and install Git](https://git-scm.com/downloads) +* [Download and install Hugo](https://gohugo.io/getting-started/installing/#quick-install) +1. [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) the *Academic Kickstart* repository and clone your fork 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, i.e. replace `sourcethemes` with your GitHub username.* + +2. Initialize the theme: + + cd My_Website + git submodule update --init --recursive + +### Install with ZIP + +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 + +### Install with RStudio + +[View the guide to installing Academic with RStudio](https://sourcethemes.com/academic/docs/install/#install-with-rstudio) + +## Quick start + +1. If you installed on your computer, view your new website by running the following command: + hugo server - 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 - -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). - - -## Getting Started - -Assuming you created a new website with the example content following the installation steps above, this section explores just a few more steps in order to customize it. - -### Core parameters - -The core parameters for the website can be edited in the `config.toml` configuration file: - -- Set `baseurl` to your website URL (we recommend [GitHub Pages](https://georgecushen.com/create-your-website-with-hugo/) for free hosting) -- Set `title` to your desired website title such as your name -- The example Disqus commenting variable should be cleared (e.g. `disqusShortname = ""`) or set to your own [Disqus](https://disqus.com/) shortname to enable commenting -- Edit your details under `[params]`; these will be displayed mainly in the homepage *about* and *contact* widgets (if used). To disable a contact field, simply clear the value to `""`. -- Place a square cropped portrait photo named `portrait.jpg` into the `static/img/` folder, overwriting any defaults. Note that you can edit the `avatar` filepath to point to a different image name or clear the value to disable the avatar feature. Alternatively, set `gravatar` to `true` to use the Gravatar/Wordpress avatar associated with your `email` address. -- To enable LaTeX math for your site, set `math = true` -- Social/academic networking links are defined as multiples of `[[params.social]]`. They can be created or deleted as necessary. - -### Introduce yourself - -Edit your biography in the *about* widget `content/home/about.md` that you copied across from the `themes/academic/exampleSite/` folder. The research interests and qualifications are stored as `interests` and `education` variables. The academic qualifications are defined as multiples of `[[education.courses]]` and can be created or deleted as necessary. It's possible to completely hide the interests and education lists by deleting their respective variables. - -### Customize the homepage - -Refer to our guide on using [widgets]({{< ref "post/widgets.md" >}}) to customize your homepage. - -### Add your content - -Refer to our guide on [managing content]({{< ref "post/managing-content.md" >}}) to create your own publications, blog posts, talks, and projects. - -### Remove unused widgets and pages - -[How to remove unused widgets and content pages]({{< ref "post/managing-content.md#removing-content" >}}). - -### Themes - -The following color themes are available and can be set by the `color_theme` option in `config.toml`: - -| `default` | `ocean` | -| --- | --- | -| ![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` | `coffee` + `playfair` font | -| --- | --- | -| ![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) | - -| `dark` | -| --- | -| ![dark theme](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-dark.png) | - -The following font styles are available and can be set by the `font` option in `config.toml`: - -- default (modern) -- classic (original Academic v1 style) -- playfair (serif) - - -### Customization & updating - -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 update the framework in the future. - -### Navigation menu - -The `[[menu.main]]` entries towards the bottom of `config.toml` define the navigation links at the top of the website. They can be added or removed as desired. - -To create a dropdown sub-menu, add `identifier = "something"` to the parent item and `parent = "something"` to the child item. - -### Website icon - -Save your main icon and mobile icon as square PNG images named `icon.png` and `apple-touch-icon.png`, respectively. Place them in your root `static/img/` folder. - -### Analytics - -To enable [Google Analytics](http://www.google.com/analytics), add your tracking code in `config.toml` similarly to `googleAnalytics = "UA-12345678-9"`. - -### Third party and local scripts (JS) - -To add a third party script, create a file named `head_custom.html` in a `layouts/partials/` folder at the root of your website (not in the `themes` folder). Any HTML code added to this file will be included within your website's ``. Therefore, it's suitable for adding custom metadata or third party scripts specified with the *async* attribute. - -Whereas for your own local scripts, you can link your local JS assets (relative to your root `static/js`) from your `config.toml` using `custom_js = ["custom.js"]`. - -### Language and translation - -The interface text (e.g. buttons) is stored in language files which are collected from Academic's `themes/academic/i18n/` folder, as well as an `i18n/` folder at the root of your project. - -To edit the interface text, copy `themes/academic/i18n/en.yaml` to `i18n/en.yaml` (relative to the root of your website). Open the new file and make any desired changes to the text appearing after `translation:`. Note that the language files are formatted in YAML syntax. - -To translate the interface text to another language, follow the above instructions, but name the new file in the form `i18n/X.yaml` where `X` is the appropriate [ISO/RFC5646 language identifier](http://www.w3schools.com/tags/ref_language_codes.asp) for the translation. Then follow the brief instructions in the *Language* section at the bottom of your `config.toml`. To change the default language used by Academic, set `defaultContentLanguage` to the desired language identifier in your configuration file. - -To translate the navigation bar, you can edit the default `[[menu.main]]` instances in `config.toml`. However, for a multilingual site, you will need to duplicate all of the `[[menu.main]]` instances and rename the new instances from `[[menu.main]]` to `[[Languages.X.menu.main]]`, where `X` is the language identifier (e.g. `[[Languages.zh.menu.main]]` for Simplified Chinese). Thus, the navigation bar can be displayed in multiple languages. - -To translate a content file in your `content/` folder into another language, copy the file to `filename.X.md` where `filename` is your existing filename and `X` is the appropriate [ISO/RFC5646 language identifier](http://www.w3schools.com/tags/ref_language_codes.asp) for the translation. Then translate the content in the new file to the specified language. - -For further details on Hugo's internationalization and multilingual features, refer to the [associated Hugo documentation](https://gohugo.io/content/multilingual/). - -### Permalinks - -*Permalinks*, or *permanent links*, are URLs to individual pages and posts on your website. They are permanent web addresses which can be used to link to your content. Using Hugo's *permalinks* option these can be easily customized. For example, the blog post URL can be changed to the form *yourURL/2016/05/01/my-post-slug* by adding the following near the top of your `config.toml` (before `[params]` settings): - - [permalinks] - post = "/:year/:month/:day/:slug" - -Where `:slug` defaults to the filename of the post, excluding the file extension. However, slug may be overridden on a per post basis if desired, simply by setting `slug = "my-short-post-title"` in your post preamble. - -**Example 2:** let's consider changing the URL path of posts from `post/` to `blog/`. First, add the following parameters right above the `[params]` section of your `config.toml`: -``` -[permalinks] - post = "/blog/:slug" -``` -Then add `aliases = ["/blog/"]` to your post archive page `post/_index.md` so that it can be accessed from the */blog/* URL. - -### Advanced style customization (CSS) - -For advanced customization of the style, you can link custom CSS assets (relative to your root `static/css`) from your `config.toml` using `custom_css = ["custom.css"]`. - -For example, let's override some of Academic's default styles. First, define `custom_css = ["override.css"]` in `config.toml`. Then we can create the file `static/css/override.css`, relative to your website root (i.e. **not** in the `themes` directory). Add your custom CSS to this file. + 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://themes.gohugo.io/theme/academic/) +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). ## Updating 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. -Before updating the framework, it is recommended to make a backup of your entire website directory, or at least your `themes/academic` directory. +Before updating the framework, it is recommended to make a backup of your entire website directory (or at least your `themes/academic` directory) and record your current version number. -Before updating for the first time, the remote *origin* repository should be renamed to *upstream*: +By default, Academic is installed as a Git submodule which can be updated by running the following command: - $ cd themes/academic - $ git remote rename origin upstream - -To list available updates: - - $ cd themes/academic - $ git fetch upstream - $ git log --pretty=oneline --abbrev-commit --decorate HEAD..upstream/master - -Then, update by running: - - $ git pull upstream - -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 `). - -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. +```bash +git submodule update --remote --merge +``` +[Check out the update guide](https://sourcethemes.com/academic/docs/update/) for full instructions and alternative methods. ## Feedback & Contributing 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. -For general questions about Hugo, there is a [Hugo discussion forum](http://discuss.gohugo.io). - +For support, head over to the [Hugo discussion forum](http://discuss.gohugo.io). ## License -Copyright 2017 [George Cushen](https://georgecushen.com). +Copyright 2016-present [George Cushen](https://georgecushen.com). Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license. diff --git a/exampleSite/content/post/managing-content.md b/exampleSite/content/post/managing-content.md deleted file mode 100644 index 686bcade..00000000 --- a/exampleSite/content/post/managing-content.md +++ /dev/null @@ -1,206 +0,0 @@ -+++ -date = 2016-04-18 -draft = false -tags = ["academic", "hugo"] -title = "Managing content" -math = false -+++ - -This is a brief guide to managing content with the Academic framework. Content can include publications, projects, talks, news/blog articles, and widget pages. 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" >}}). - -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`. - -To disable source code highlighting by default for all pages, set `highlight = false` in `config.toml`. You can then enable source code highlighting only on pages that need it by setting `highlight = true` in that page's preamble. See the [code-highlighting docs]({{< ref "post/writing-markdown-latex.md#code-highlighting" >}}) for more details. - -To display a featured image in content page headers, the parameters below can be inserted towards the end of a page's `+++` preamble. It is assumed that the image is located in your `static/img/` folder, so the full path in the example below will be `static/img/headers/getting-started.png`. The `caption` parameter can be used to write an image caption or credit. - -```toml -[header] -image = "headers/getting-started.png" -caption = "Image credit: [**Academic**](https://github.com/gcushen/hugo-academic/)" - -``` - -{{% alert note %}} -If you wish to prevent a featured image automatically being used for a post's thumbnail on the homepage, the `preview = false` parameter can be added to `[header]`. -{{% /alert %}} - -{{% toc%}} - -## 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: - -``` -+++ -title = "A publication title, such as title of a paper" - -# Date first published. -date = "2013-07-01" - -# Authors. Comma separated list, e.g. `["Bob Smith", "David Jones"]`. -authors = ["First author's name", "Second author's name"] - -# Publication type. -# Legend: -# 0 = Uncategorized -# 1 = Conference proceedings -# 2 = Journal -# 3 = Work in progress -# 4 = Technical report -# 5 = Book -# 6 = Book chapter -publication_types = ["1"] - -# Publication name and optional abbreviated version. -publication = "In *International Conference on Academic*. You may use *Markdown* for italics etc." -publication_short = "In *ICA*" - -# Abstract and optional shortened version. -abstract = "The abstract. Markdown and math can be used (note that math may require escaping as detailed in the red alert box below)." -abstract_short = "A short version of the abstract." - -# Featured image thumbnail (optional) -image_preview = "" - -# Is this a selected publication? (true/false) -selected = true - -# Projects (optional). -# Associate this publication with one or more of your projects. -# Simply enter the filename (excluding '.md') of your project file in `content/project/`. -# E.g. `projects = ["deep-learning"]` references `content/project/deep-learning.md`. -projects = [] - -# Links (optional). -url_pdf = "pdf/my-paper-name.pdf" -url_preprint = "" -url_code = "" -url_dataset = "" -url_project = "" -url_slides = "" -url_video = "" -url_poster = "" -url_source = "" - -# Custom links (optional). -# Uncomment line below to enable. For multiple links, use the form `[{...}, {...}, {...}]`. -# url_custom = [{name = "Custom Link", url = "http://example.org"}] - -# Does the content use math formatting? -math = true - -# Does the content use source code highlighting? -highlight = true - -# Featured image -# Place your image in the `static/img/` folder and reference its filename below, e.g. `image = "example.jpg"`. -[header] -image = "headers/bubbles-wide.jpg" -caption = "My caption :smile:" - -+++ - -Further details on your publication can be written here using *Markdown* for formatting. This text will be displayed on the Publication Detail page. -``` - -The `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 within the variable preamble above, which is denoted by `+++`: - -``` -url_custom = [{name = "Custom Link 1", url = "http://example.org"}, - {name = "Custom Link 2", url = "http://example.org"}] -``` - -If you set `list_format=2` to enable a detailed listing of publications in the Publication Widget (`home/publications.md`) or Publication Archive (`publication/_index.md`), 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. - -{{% alert warning %}} -Any double quotes (`"`) or backslashes (e.g. LaTeX `\times`) occurring within the value of any frontmatter parameter (such as the *abstract*) should be escaped with a backslash (`\`). For example, the symbol `"` and LaTeX text `\times` become `\"` and `\\times`, respectively. Refer to the [TOML documentation](https://github.com/toml-lang/toml#user-content-string) for more info. -{{% /alert %}} - -## Create a blog post - -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 `config.toml`. - -## 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. - -## Create a talk - -To create a talk: - - hugo new talk/my-talk-name.md - -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. - -## Create a widget page - -So you would like to create a page which utilizes Academic's widget system, similar to the homepage? - -Create a new folder in your `content` folder, naming it with your new page name. In this example, we will create a *courses* page by creating a `content/courses/` folder. - -Within your new `content/courses/` folder, create a file named `_index.md` containing the following parameters: - -``` -+++ -title = "Courses" -date = 2017-01-01 -widgets = true -+++ -``` - -Install widgets into your `content/courses/` folder. To achieve this, widgets can be copied from your `content/home/` folder or downloaded from [Github](https://github.com/gcushen/hugo-academic/tree/master/exampleSite/content/home). - -## Create other pages (e.g. CV) - -For other types of content, it is possible to create your own custom pages. For example, let's create a `cv.md` page for your Curriculum Vitae in your `content` folder. Copy across the frontmatter from the top of one of your post files, adapting it as necessary, and editing your Markdown content below. You can then link to your new page by adding the code `[My CV]{{}}` to any of your existing content. - -Alternatively, for the above example, we could use a PDF of your Curriculum Vitae. For this purpose, create a folder called `files` within your `static` folder and move a PDF file named `cv.pdf` to that location, so we have a `static/files/cv.pdf` file path. The PDF can then be linked to from any content by using the code: `{{%/* staticref "files/cv.pdf" */%}}Download my CV{{%/* /staticref */%}}`. - -## Manage archive pages - -The archive (or *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 archive 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 copying the following content `_index.md` files from the example site to the same structure within your `content/` folder: - - /themes/academic/exampleSite/content/post/_index.md - /themes/academic/exampleSite/content/publication/_index.md - /themes/academic/exampleSite/content/talk/_index.md - -Then edit the `title` parameter in each `_index.md` as desired and add any content after the `+++` preamble/frontmatter ends. You will notice that the `_index.md` files differ slightly, with some having special options available for the associated content type. For example, `publication/_index.md` contains an option for setting the citation style of the listings which appear on the publication archive page. - -## Removing content - -Generally, to remove content, simply delete the relevant file from your `content/post`, `content/publication`, `content/project`, or `content/talk` folder. - -## View your updated site - -After you have made changes to your site, you can view it by running the `hugo server` command and then opening [localhost:1313](http://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 `hugo` command. - -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. diff --git a/exampleSite/content/post/migrate-from-jekyll.md b/exampleSite/content/post/migrate-from-jekyll.md deleted file mode 100644 index 77d11a25..00000000 --- a/exampleSite/content/post/migrate-from-jekyll.md +++ /dev/null @@ -1,38 +0,0 @@ -+++ -date = 2014-03-10 -draft = false -tags = ["jekyll"] -title = "Migrate from Jekyll to Hugo" -summary = """ -Learn how to migrate an existing website from Jekyll to Hugo. -""" -math = false -+++ - -Here are a few tips for migrating an existing website from Jekyll to Hugo. These tips can be applied in conjunction with following Hugo Academic's [getting started guide]({{< ref "post/getting-started.md" >}}). - -## Move static content to `static` -Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there. -With Jekyll, something that looked like - - ▾ / - ▾ images/ - logo.png - -should become - - ▾ / - ▾ static/ - ▾ images/ - logo.png - -Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`. - -## Fix content -Depending on the amount of customization that was done for each post in Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server --watch` and the Hugo Academic example site are your friends. Test your changes and fix errors as needed. - -## Publish -The default is for Jekyll to publish the website to a `_site` directory, whereas Hugo publishes to a `public` directory. - -## A practical example -Alexandre Normand migrated his website from Jekyll to Hugo in less than a day. You can see all his changes by looking at this GitHub [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610). However, bear in mind that this example is **not specific to the Academic theme nor does it use the latest version of Hugo**. diff --git a/exampleSite/content/post/widgets.md b/exampleSite/content/post/widgets.md deleted file mode 100644 index acbc6fac..00000000 --- a/exampleSite/content/post/widgets.md +++ /dev/null @@ -1,63 +0,0 @@ -+++ -date = 2016-04-19 -draft = false -tags = ["academic", "hugo"] -title = "Customizing the homepage with widgets" -math = false -summary = """ -Enable/disable and configure widgets to customize your homepage. -""" -+++ - -Homepage widgets display as sections on the homepage. They can be enabled/disabled and configured as desired. Academic has the following widgets available to use: - -- About/biography -- Selected publications -- Recent publications -- Recent news/blog posts -- Projects -- Selected talks -- Recent talks -- Contact -- Tag cloud -- Hero (introduction) -- Custom widget (demonstrated with the *teaching* example) - -The example site that you copied to create your site uses all the different types of widget (except talks), so you can generally just delete the widgets you don't need and customize the parameters of the widgets you wish to keep. - -The parameters for each widget vary. They can be found in the preamble/frontmatter (between the pair of `+++`) for each widget installed in the `content/home/` folder. - -{{% alert note %}} -By default, publications will be displayed in a simple list. If you prefer a more detailed list with abstract and image, you can enable the detailed publication list on the homepage by setting `list_format = 2` in `content/home/publications.md`. -{{% /alert %}} - -## Add a widget to the homepage - -To add a widget manually, copy the relevant widget from `themes/academic/exampleSite/content/home/` to your `content/home/` folder. - -Widget identifiers are set to their respective filenames, so a `content/home/about.md` widget can be linked from the navigation bar by setting the relevant URL as `"#about"` in `config.toml`. - -This means that if you want to use multiple instances of a widget, each widget will be assigned a unique ID based on the filename that you set. You can then use that ID for linking, like in the above example. - -## Using the custom widget - -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 widget from the homepage - -If you do not require a particular widget, you can simply delete any associated files from the `content/home/` folder. - -To remove a navigation link from the top of the page, remove the associated `[[menu.main]]` entry in `config.toml`. - -## Ordering widgets - -The order that the homepage widgets are displayed in is defined by the `weight` parameter in each of the files in the `content/home/` directory. The widgets are displayed in ascending order of their `weight`, so you can simply edit the `weight` parameters as desired. diff --git a/exampleSite/content/post/writing-markdown-latex.md b/exampleSite/content/post/writing-markdown-latex.md deleted file mode 100644 index 6f4adfa8..00000000 --- a/exampleSite/content/post/writing-markdown-latex.md +++ /dev/null @@ -1,265 +0,0 @@ -+++ -date = 2016-04-17 -draft = false -tags = [] -title = "Writing content with Markdown, LaTeX, and Shortcodes" -math = true -+++ - -Content can be written using [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet), [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics), and [Hugo Shortcodes](http://gohugo.io/extras/shortcodes/). Additionally, HTML may be used for advanced formatting. This article gives an overview of the most common formatting options. - -{{% toc %}} - -## Sub-headings - - ## Heading 2 - ### Heading 3 - #### Heading 4 - ##### Heading 5 - ###### Heading 6 - -## Emphasis - - Italics with *asterisks* or _underscores_. - - Bold with **asterisks** or __underscores__. - - Combined emphasis with **asterisks and _underscores_**. - - Strikethrough with ~~two tildes~~. - -## Ordered lists - - 1. First item - 2. Another item - -## Unordered lists - - * First item - * Another item - -## Images - -Images may be added to a page by placing them in your `static/img/` folder and referencing them using one of the following two notations: - -A general image: - - ![alternative text for search engines](/img/screenshot.png) - -A numbered figure with caption: - - {{}} - -## Links - - [I'm a link](https://www.google.com) - [A post]({{}}) - [A publication]({{}}) - [A project]({{}}) - [Another section]({{}}) - -To enable linking to a file, such as a PDF, first place the file in your `static/files/` folder and then link to it using the following form: - - {{%/* staticref "files/cv.pdf" "newtab" */%}}Download my CV{{%/* /staticref */%}} - -The optional `"newtab"` argument for `staticref` will cause the link to be opened in a new tab. - -## Emojis - -See the [Emoji cheat sheet](http://www.webpagefx.com/tools/emoji-cheat-sheet/) for available emoticons. The following serves as an example, but you should remove the spaces between each emoji name and pair of semicolons: - - I : heart : Academic : smile : - -I :heart: Academic :smile: - -## Blockquote - - > This is a blockquote. - -> This is a blockquote. - -## Footnotes - - I have more [^1] to say. - - [^1]: Footnote example. - -I have more [^1] to say. -[^1]: Footnote example. - -## Code highlighting - -Pass the *language* of the code, such as `python`, as a parameter after three backticks: - - ```python - # Example of code highlighting - input_string_var = input("Enter some data: ") - print("You entered: {}".format(input_string_var)) - ``` -Result: - -```python -# Example of code highlighting -input_string_var = input("Enter some data: ") -print("You entered: {}".format(input_string_var)) -``` - -### Highlighting options - -The Academic theme uses [highlight.js](https://highlightjs.org) for source code highlighting, and highlighting is enabled by default for all pages. However, several configuration options are supported that allow finer-grained control over highlight.js. - -The following table lists the supported options for configuring highlight.js, along with their expected type and a short description. A "yes" in the **config.toml** column means the value can be set globally in `config.toml`, and a "yes" in the **preamble** column means that the value can be set locally in a particular page's preamble. - -option | type | description | config.toml | preamble -----------------------|---------|---------------------------------|-------------|--------- -`highlight` | boolean | enable/disable highlighting | yes | yes -`highlight_languages` | slice | choose additional languages | yes | yes -`highlight_style` | string | choose a highlighting style | yes | no - - -#### Option `highlight` - -The `highlight` option allows enabling or disabling the inclusion of highlight.js, either globally or for a particular page. If the option is unset, it has the same effect as if you had specified `highlight = true`. That is, the highlight.js javascript and css files will be included in every page. If you'd like to only include highlight.js files on pages that actually require source code highlighting, you can set `highlight = false` in `config.toml`, and then override it by setting `highlight = true` in the preamble of any pages that require source code highlighting. Conversely, you could enable highlighting globally, and disable it locally for pages that do not require it. Here is a table that shows whether highlighting will be enabled for a page, based on the values of `highlight` set in `config.toml` and/or the page's preamble. - -config.toml | page preamble | highlighting enabled for page? ---------------|----------------|------------------------------- -unset or true | unset or true | yes -unset or true | false | no -false | unset or false | no -false | true | yes - -#### Option `highlight_languages` - -The `highlight_languages` option allows you to specify additional languages that are supported by highlight.js, but are not considered "common" and therefore are not supported by default. For example, if you want source code highlighting for Go and clojure in all pages, set `highlight_languages = ["go", "clojure"]` in `config.toml`. If, on the other hand, you want to enable a language only for a specific page, you can set `highlight_languages` in that page's preamble. - -The `highlight_languages` options specified in `config.toml` and in a page's preamble are additive. That is, if `config.toml` contains, `highlight_languages = ["go"]` and the page's preamble contains `highlight_languages = ["ocaml"]`, then javascript files for *both* go and ocaml will be included for that page. - -If the `highlight_languages` option is set, then the corresponding javascript files will be served from the [cdnjs server](https://cdnjs.com/libraries/highlight.js/). To see a list of available languages, visit the [cdnjs page](https://cdnjs.com/libraries/highlight.js/) and search for links with the word "languages". - -The `highlight_languages` option provides an easy and convenient way to include support for additional languages to be severed from a CDN. If serving unmodified files from cdnjs doesn't meet your needs, you can include javascript files for additional language support via one of the methods described in the [getting started guide]({{< ref "post/getting-started.md#third-party-and-local-scripts-js" >}}). - -#### Option `highlight_style` - -The `highlight_style` option allows you to select an alternate css style for highlighted code. For example, if you wanted to use the solarized-dark style, you could set `highlight_style = "solarized-dark"` in `config.toml`. - -If the `highlight_style` option is unset, the default is to use the file `/css/highlight.min.css`, either the one provided by the Academic theme, or else the one in your local `static` directory. The `/css/highlight.min.css` file provided by Academic is equivalent to the `github` style from highlight.js. - -If the `highlight_style` option *is* set, then `/css/highlight.min.css` is ignored, and the corresponding css file will be served from the [cdnjs server](https://cdnjs.com/libraries/highlight.js/). To see a list of available styles, visit the [cdnjs page](https://cdnjs.com/libraries/highlight.js/) and search for links with the word "styles". - -See the [highlight.js demo page](https://highlightjs.org/static/demo/) for examples of available styles. - -{{% alert note %}} -Not all styles listed on the [highlight.js demo page](https://highlightjs.org/static/demo/) are available from the [cdnjs server](https://cdnjs.com/libraries/highlight.js/). If you want to use a style that is not served by cdnjs, just leave `highlight_style` unset, and place the corresponding css file in `/static/css/highlight.min.css`. -{{% /alert %}} - -{{% alert note %}} -If you don't want to change the default style that ships with Academic but you do want the style file served from the [cdnjs server](https://cdnjs.com/libraries/highlight.js/), set `highlight_style = "github"` in `config.toml`. -{{% /alert %}} - -The `highlight_style` option is only recognized when set in `config.toml`. Setting `highlight_style` in your page's preamble has no effect. - -## Twitter tweet - -To include a single tweet, pass the tweet’s ID from the tweet's URL as parameter to the shortcode: - - {{}} - -## Youtube - - {{}} - -## Vimeo - - {{}} - -## GitHub gist - - {{}} - -## Speaker Deck - - {{}} - -## $\rm \LaTeX$ math - -```TeX -$$\left [ – \frac{\hbar^2}{2 m} \frac{\partial^2}{\partial x^2} + V \right ] \Psi = i \hbar \frac{\partial}{\partial t} \Psi$$ -``` - -$$\left [ – \frac{\hbar^2}{2 m} \frac{\partial^2}{\partial x^2} + V \right ] \Psi = i \hbar \frac{\partial}{\partial t} \Psi$$ - -Alternatively, inline math can be written by wrapping the formula with only a single `$`: - - This is inline: $\mathbf{y} = \mathbf{X}\boldsymbol\beta + \boldsymbol\varepsilon$ - -This is inline: $\mathbf{y} = \mathbf{X}\boldsymbol\beta + \boldsymbol\varepsilon$ - -Note that Markdown special characters need to be escaped with a backslash so they are treated as math rather than Markdown. For example, `*` and `_` become `\*` and `\_` respectively. - -### Multiline equations - -The standard LaTeX line break consisting of 2 backslashes needs to be replaced with 6 backslashes: - -```TeX -$$f(k;p\_0^\*) = \begin{cases} p\_0^\* & \text{if }k=1, \\\\\\ -1-p\_0^\* & \text {if }k=0.\end{cases}$$ -``` - -$$f(k;p\_0^\*) = \begin{cases} p\_0^\* & \text{if }k=1, \\\\\\ -1-p\_0^\* & \text {if }k=0.\end{cases}$$ - -### Publication abstracts - -As Hugo and Academic attempt to parse TOML, Markdown, and LaTeX content in the abstract, the following guidelines should be followed just for the publication `abstract` and `abstract_short` fields: - -- escape each LaTeX backslash (`\`) with an extra backslash, yielding `\\` -- escape each LaTeX underscore (`_`) with two backslashes, yielding `\\_` - -Hence, `abstract = "${O(d_{\max})}$"` becomes `abstract = "${O(d\\_{\\max})}$"`. - -## Table - -Code: - -```Markdown -| Command | Description | -| ------------------| ------------------------------ | -| `hugo` | Build your website. | -| `hugo serve -w` | View your website. | -``` - -Result: - -| Command | Description | -| ------------------| ------------------------------ | -| `hugo` | Build your website. | -| `hugo serve -w` | View your website. | - - -## Alerts - -Alerts are a useful feature that add side content such as tips, notes, or warnings to your articles. They are especially handy when writing educational tutorial-style articles. Use the corresponding shortcodes to enable alerts inside your content: - - {{%/* alert note */%}} - Here's a tip or note... - {{%/* /alert */%}} - -This will display the following *note* block: - -{{% alert note %}} -Here's a tip or note... -{{% /alert %}} - - {{%/* alert warning */%}} - Here's some important information... - {{%/* /alert */%}} - -This will display the following *warning* block: - -{{% alert warning %}} -Here's some important information... -{{% /alert %}} - -## Table of Contents - -A table of contents may be particularly useful for long posts or tutorial/documentation type content. Use the `{{%/* toc */%}}` shortcode anywhere you wish within your Markdown content to automatically generate a table of contents.