diff --git a/README.md b/README.md index 819a787f..2930dba1 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,18 @@ A personal academic website theme for [Hugo](https://gohugo.io). Key features: - Designed for academic staff, students, or general personal use -- Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact sections +- Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact widgets - Write in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions -- Academic linking (Scholar etc.), Google Analytics, and Disqus comments +- Academic linking (Scholar etc.), [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/) -## Installation +## Getting Started -1. Install [Hugo](https://gohugo.io/overview/installing/) and create a new website: +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: hugo new site my_website cd my_website @@ -39,15 +39,13 @@ Latest demo: [gcushen.github.io/hugo-academic-demo/](http://gcushen.github.io/hu 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](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 -## Getting Started - -Refer to the [documentation](http://gcushen.github.io/hugo-academic-demo/#posts) under the *Posts* section of the latest Academic theme demo. +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 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. 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). @@ -70,12 +68,16 @@ If you have modified files in `themes/academic`, git will attempt to auto-merge If there are any issues after upgrading, 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. -## Contributing +## 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). + ## License Copyright 2016 [George Cushen](https://georgecushen.com). Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license. + +[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/hugo-academic/readme?pixel)](https://github.com/igrigorik/ga-beacon) diff --git a/exampleSite/content/post/getting-started.md b/exampleSite/content/post/getting-started.md index 809bbb00..c884457f 100644 --- a/exampleSite/content/post/getting-started.md +++ b/exampleSite/content/post/getting-started.md @@ -14,7 +14,7 @@ Key features: - Designed for academic staff, students, or general personal use - Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact sections - Write in [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for easy formatting and code highlighting, with [LaTeX](https://en.wikibooks.org/wiki/LaTeX/Mathematics) for mathematical expressions -- Academic linking (Scholar etc.), Google Analytics, and Disqus comments +- Academic linking (Scholar etc.), [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 @@ -23,7 +23,7 @@ Key features: ## Installation -1. Install [Hugo](https://gohugo.io/overview/installing/) and create a new website: +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: hugo new site my_website cd my_website @@ -44,7 +44,9 @@ Key features: 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 - 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 @@ -120,7 +122,7 @@ Where `:slug` defaults to the filename of the post, excluding the file extension ## Upgrading -Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and monitor the commits 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. 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). @@ -144,10 +146,12 @@ If you have modified files in `themes/academic`, git will attempt to auto-merge If there are any issues after upgrading, 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. -## Contributing +## 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). + ## License