Skip to content

Commit 76508a5

Browse files
John SpergerJohn Sperger
John Sperger
authored and
John Sperger
committed
This is a test
1 parent 47765b4 commit 76508a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+8232
-0
lines changed

.DS_Store

6 KB
Binary file not shown.

.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "public"]
2+
path = public
3+
url = git@github.com:jsperger/jsperger.github.io.git
4+
branch = master

config.toml

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
baseurl = "http://jsperger.github.io/"
2+
title = "Academic Theme"
3+
copyright = "© 2016 John Sperger"
4+
languageCode = "en-us"
5+
theme = "academic"
6+
canonifyurls = true
7+
8+
# Enable comments by entering your Disqus shortname
9+
disqusShortname = ""
10+
11+
# Enable analytics by entering your Google Analytics tracking ID
12+
googleAnalytics = ""
13+
14+
15+
[params]
16+
name = "John Sperger"
17+
role = "Senior Research Coordinator"
18+
organization = "University of Pennsylvania"
19+
avatar = "portrait.jpg"
20+
email = "j.sperger@gmail.com"
21+
22+
# Date format (refer to Go's date format: http://flippinggodateformat.com )
23+
# Examples: "Mon, Jan 2, 2006" or "2006-01-02"
24+
date_format = "Mon, Jan 2, 2006"
25+
26+
# Enable global LaTeX math rendering? If false, you can enable it locally on a per page basis.
27+
math = true
28+
29+
# Enable native social sharing buttons?
30+
sharing = true
31+
32+
# Link custom CSS and JS assets (relative to /static/css and /static/js respectively)
33+
custom_css = []
34+
custom_js = []
35+
36+
# Biography section.
37+
# Section will only be displayed if `content/home/about.md` exists.
38+
[params.about]
39+
interests = ["Artificial Intelligence", "Computational Linguistics", "Information Retrieval"]
40+
str_interests = "Interests"
41+
str_education = "Education"
42+
43+
[[params.about.education]]
44+
course = "PhD in Artificial Intelligence"
45+
institution = "Stanford University"
46+
year = 2012
47+
48+
[[params.about.education]]
49+
course = "MEng in Artificial Intelligence"
50+
institution = "Massachusetts Institute of Technology"
51+
year = 2009
52+
53+
[[params.about.education]]
54+
course = "BSc in Artificial Intelligence"
55+
institution = "Massachusetts Institute of Technology"
56+
year = 2008
57+
58+
# Selected Publications section.
59+
# Section will only be displayed if there are publications with `selected = true` in their `+++` preamble.
60+
[params.publications_selected]
61+
detailed_list = true
62+
title = "Selected Publications"
63+
subtitle = ""
64+
65+
# Publications section.
66+
# Section will only be displayed if there are publications in `content/publication/`.
67+
[params.publications]
68+
count = 10
69+
detailed_list = false
70+
title = "Recent Publications"
71+
subtitle = ""
72+
str_all = "More Publications"
73+
74+
# Posts section.
75+
# Section will only be displayed if there are posts in `content/post/`.
76+
[params.posts]
77+
count = 5
78+
title = "Recent Posts"
79+
subtitle = ""
80+
str_all = "More Posts"
81+
str_read_more = "Read more"
82+
83+
# Projects section.
84+
# Section will only be displayed if there are projects in `content/project/`.
85+
[params.projects]
86+
title = "Projects"
87+
subtitle = ""
88+
89+
# Contact section.
90+
[params.contact]
91+
enable = true
92+
title = "Contact"
93+
subtitle = ""
94+
autolink = true # Automatically link email and phone?
95+
96+
# Social/Academic Networking
97+
#
98+
# Icon pack "fa" includes the following social network icons:
99+
# twitter, weibo, linkedin, github, facebook, pinterest, google-plus, youtube, instagram, soundcloud
100+
# For email icon, use "fa" icon pack, "envelope" icon, and "mailto:your@email.com" as the link.
101+
# Full list: https://fortawesome.github.io/Font-Awesome/icons/
102+
#
103+
# Icon pack "ai" includes the following academic network icons:
104+
# google-scholar, arxiv, orcid, researchgate, mendeley
105+
# Full list: https://jpswalsh.github.io/academicons/
106+
107+
[[params.social]]
108+
icon = "envelope"
109+
icon_pack = "fa"
110+
link = "mailto:test@example.org"
111+
112+
[[params.social]]
113+
icon = "twitter"
114+
icon_pack = "fa"
115+
link = "//twitter.com/GeorgeCushen"
116+
117+
[[params.social]]
118+
icon = "google-scholar"
119+
icon_pack = "ai"
120+
link = "https://scholar.google.co.uk/citations?user=sIwtMXoAAAAJ"
121+
122+
[[params.social]]
123+
icon = "github"
124+
icon_pack = "fa"
125+
link = "//github.com/gcushen"
126+
127+
128+
# Navigation Links
129+
# The weight parameter defines the order that the links will appear in.
130+
131+
[[menu.main]]
132+
name = "Home"
133+
url = "#top"
134+
weight = 1
135+
136+
[[menu.main]]
137+
name = "Publications"
138+
url = "#publications"
139+
weight = 2
140+
141+
[[menu.main]]
142+
name = "Posts"
143+
url = "#posts"
144+
weight = 3
145+
146+
[[menu.main]]
147+
name = "Projects"
148+
url = "#projects"
149+
weight = 4
150+
151+
[[menu.main]]
152+
name = "Teaching"
153+
url = "#teaching"
154+
weight = 5
155+
156+
[[menu.main]]
157+
name = "Contact"
158+
url = "#contact"
159+
weight = 6

content/home/about.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
+++
2+
date = "2016-04-20T00:00:00"
3+
draft = false
4+
title = "about"
5+
section_id = 0
6+
weight = 0
7+
+++
8+
9+
# Biography
10+
11+
Lena Smith is a professor of artificial intelligence at the Stanford AI Lab. Her research interests include distributed robotics, mobile computing and programmable matter. She leads the Robotic Neurobiology group, which develops self-reconfiguring robots, systems of self-organizing robots, and mobile sensor networks.
12+
13+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed neque elit, tristique placerat feugiat ac, facilisis vitae arcu. Proin eget egestas augue. Praesent ut sem nec arcu pellentesque aliquet. Duis dapibus diam vel metus tempus vulputate. Etiam iaculis libero hendrerit ipsum tempus accumsan. Praesent ex justo, aliquam bibendum nulla in, vehicula rhoncus massa. Fusce gravida mattis tellus vel commodo. Etiam molestie non ligula ac venenatis. Integer semper diam at fringilla dapibus. Nunc tincidunt lacinia nisi, sed blandit purus fermentum vel. Morbi tempus dolor dolor. Phasellus scelerisque est elit, et porttitor mauris faucibus sit amet. Phasellus sollicitudin bibendum sem eu blandit. Curabitur congue felis eu velit faucibus porta. Curabitur a pharetra diam.

content/home/teaching.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
+++
2+
date = "2016-04-20T00:00:00"
3+
draft = false
4+
title = "teaching"
5+
subtitle = ""
6+
section_id = 10
7+
weight = 10
8+
+++
9+
10+
I am a teaching instructor for the following courses at University X:
11+
12+
- CS101: An intro to computer science
13+
- CS102: An intro to computer science
14+
- CS103: An intro to computer science
15+
- CS104: An intro to computer science
16+
- CS105: An intro to computer science
17+
- CS106: An intro to computer science
18+
- CS107: An intro to computer science

content/post/getting-started.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
+++
2+
date = "2016-04-20T12:00:00"
3+
draft = false
4+
image = "banners/getting-started.png"
5+
tags = ["academic", "hugo"]
6+
title = "Getting started with the Academic theme for Hugo"
7+
math = true
8+
+++
9+
10+
The Academic theme enables you to easily create a personal academic website using the [Hugo](https://gohugo.io) static site generator.
11+
12+
Key features:
13+
14+
- Designed for academic staff, students, or general personal use
15+
- Includes Biography, Publications, Projects, News/Blog, Teaching, and Contact sections
16+
- 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
17+
- Academic linking (Scholar etc.), Google Analytics, and Disqus comments
18+
- Responsive and mobile friendly
19+
- Simple and refreshing one page design
20+
- Easy to customize
21+
22+
23+
## Installation
24+
25+
1. Install [Hugo](https://gohugo.io/overview/installing/) and create a new website:
26+
27+
hugo new site my_website
28+
cd my_website
29+
30+
2. Install Academic theme with [git](https://help.github.com/articles/set-up-git/):
31+
32+
git clone https://github.com/gcushen/hugo-academic.git themes/academic
33+
34+
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.
35+
36+
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.
37+
38+
cp -av themes/academic/exampleSite/* .
39+
40+
4. Start the Hugo server from your website root folder:
41+
42+
hugo server --watch
43+
44+
Now you can go to [localhost:1313](http://localhost:1313) and your new Academic themed website should appear.
45+
46+
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.
47+
48+
49+
## Getting Started
50+
51+
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.
52+
53+
The core parameters for the website can be edited in the `config.toml` configuration file.
54+
55+
As can be seen in the example `config.toml`, the social/academic networking icons and education qualifications are defined as multiples of `[[params.social]]` and `[[params.about.education]]` respectively. They can be duplicated or deleted as necessary.
56+
57+
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 `detailed_list = true` under `[params.publications]`.
58+
59+
For deployment, the `baseURL` variable should be changed to match your website URL such as `baseURL = "http://your-site.org/"`. The example Disqus commenting variable should be cleared (e.g. `disqusShortname = ""`) or set to your own Disqus shortname to enable commenting. To enable Google Analytics, add your tracking code in `config.toml` similarly to `googleAnalytics = "UA-12345678-9"`.
60+
61+
Next, you may be interested to read the guide about [managing content]({{< ref "post/managing-content.md" >}}), or continue reading below for advanced customization tips and instructions for keeping the theme up-to-date with any improvements that become available.
62+
63+
64+
## Advanced customization
65+
66+
It is possible to carry out many customizations without touching any files in `themes/academic`, making it easier to upgrade the theme in the future.
67+
68+
### Custom theme color (CSS) or JavaScript (JS)
69+
70+
You can link custom CSS and JS assets (relative to your root `static/css` and `static/js` respectively) from your `config.toml` using `custom_css = ["custom.css"]` or `custom_js = ["custom.js"]`.
71+
72+
For example, lets make a green theme. First, define `custom_css = ["green.css"]` in `config.toml`. Then we can download the example [green theme](https://gist.github.com/gcushen/d5525a4506b9ccf83f2bce592a895495) and save it as `static/css/green.css`, relative to your website root (i.e. **not** in the `themes` directory).
73+
74+
### Permalinks
75+
76+
*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):
77+
78+
[permalinks]
79+
post = "/:year/:month/:day/:slug"
80+
81+
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.
82+
83+
84+
## Upgrading
85+
86+
Feel free to *star* the project on [Github](https://github.com/gcushen/hugo-academic/) and monitor the commits for updates.
87+
88+
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).
89+
90+
Before upgrading for the first time, the remote *origin* repository should be renamed to *upstream*:
91+
92+
$ cd themes/academic
93+
$ git remote rename origin upstream
94+
95+
To list available updates:
96+
97+
$ cd themes/academic
98+
$ git fetch upstream
99+
$ git log --pretty=oneline --abbrev-commit --decorate HEAD..upstream/master
100+
101+
Upgrade by running:
102+
103+
$ cd themes/academic
104+
$ git pull upstream
105+
106+
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 <filename>`).
107+
108+
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.
109+
110+
111+
## Contributing
112+
113+
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.
114+
115+
116+
## License
117+
118+
Copyright 2016 [George Cushen](https://georgecushen.com).
119+
120+
Released under the [MIT](https://github.com/gcushen/hugo-academic/blob/master/LICENSE.md) license.

0 commit comments

Comments
 (0)