Update docs

This commit is contained in:
George Cushen 2016-06-05 01:08:18 +01:00
commit f75dd94998
5 changed files with 21 additions and 5 deletions

View file

@ -25,7 +25,7 @@ Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hu
2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/):
git clone git@github.com:gcushen/hugo-academic.git themes/academic
git clone https://github.com/gcushen/hugo-academic.git themes/academic
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.

View file

@ -1,6 +1,7 @@
+++
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"
math = true
@ -28,7 +29,7 @@ Key features:
2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/):
git clone git@github.com:gcushen/hugo-academic.git themes/academic
git clone https://github.com/gcushen/hugo-academic.git themes/academic
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.

View file

@ -99,4 +99,14 @@ Then edit the newly created file `content/project/my-project-name.md`. Either yo
Generally, to remove content, simply delete the relevant file from your `content/post`, `content/publication`, `content/project`, or `content/home` folder.
Then you can re-build and view the updated website with the `hugo` and `hugo server --watch` commands, respectively.
## 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](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.

View file

@ -6,7 +6,7 @@ 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), [Hugo Shortcodes](http://gohugo.io/extras/shortcodes/), and [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics). Additionally, HTML may be used for advanced formatting.
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.
## Sub-headings
@ -103,13 +103,18 @@ To include a single tweet, pass the tweets ID from the tweet's URL as paramet
## $\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$
## Table
Code:

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB