michaelh/hugo-academic-mirror
1
0
Fork 0
mirror of https://github.com/gcushen/hugo-academic.git synced 2025-07-26 19:15:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix README for hugo.io's Markdown parser

Browse source
This commit is contained in:
George Cushen 2016-04-28 18:23:07 +01:00
commit aa28a616f4
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -5,6 +5,7 @@ A personal academic website theme for [Hugo](https://gohugo.io).
[![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/screenshot.png)](https://github.com/gcushen/hugo-academic/) [![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/screenshot.png)](https://github.com/gcushen/hugo-academic/)
Key features: Key features:
- Suitable for academic staff, students, or general personal use - Suitable for academic staff, students, or general personal use
- Sections for Biography, Publications, Projects, News, Teaching, and Contact - Sections for Biography, Publications, Projects, News, Teaching, and Contact
- Render LaTeX mathematical expressions and highlight code - Render LaTeX mathematical expressions and highlight code
@ -24,7 +25,7 @@ Key features:
git clone git@github.com:gcushen/hugo-academic.git themes/hugo-academic git clone git@github.com:gcushen/hugo-academic.git themes/hugo-academic
Or alternatively, install by downloading from [Github](https://github.com/gcushen/hugo-academic/) into a `themes/hugo-academic` folder within your Hugo website. Or alternatively, install by downloading from [Github](https://github.com/gcushen/hugo-academic/) into a `themes/hugo-academic` folder within your Hugo website.
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. 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.
@ -32,7 +33,7 @@ Key features:
hugo server --watch 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 themed website should appear.
5. Customize your website (see next section), build it by running `hugo`, and deploy it by copying the `public/` directory (by FTP, Rsync, git push, etc.) to your production web server. 5. Customize your website (see next section), build it by running `hugo`, and deploy it by copying the `public/` directory (by FTP, Rsync, git push, etc.) to your production web server.