Add example site

6 files changed, 302 insertions, 103 deletions

diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index acdb1e1..fb8ac11 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -1,9 +1,9 @@
+# Base information
 baseURL = "https://example.com"
 languageCode = "en-gb"
 title = "Sam Robbins"
 theme = "hugo-developer-portfolio"
-summaryLength = "10"
-
+googleAnalytics = ""
 # Plugins
 [params.plugins]
 
@@ -20,44 +20,53 @@ summaryLength = "10"
 
 # navigation
 [menu]
-    
+
   [[menu.main]]
   name = "About"
   URL = "about"
-  weight = 2
-  
+  weight=1
+
   [[menu.main]]
   name = "Blog"
   URL = "blog"
-  weight = 3
-  
+  weight=2
+
   [[menu.main]]
   name = "Portfolio"
   URL = "portfolio"
-  weight = 4
-  
+  weight=3
+
   [[menu.main]]
   name = "Contact"
   URL = "contact"
-  weight = 5
+  weight=4
 
 
 [params]
-logo = "images/logo.png"
 home = "Home"
 # Meta data
 description = "The website of Sam Robbins, 2nd Year Computer Science Student at Durham University"
 author = "Sam Robbins"
-image = "images/about/profile.jpg"
 
 
   [params.contact]
   enable = true
-  formAction = "https://formspree.io/mlegaggv" #contact form works with formspree.io
+  formAction = "" #contact form works with formspree.io
 
   [params.footer]
   email = "samrobbinsgb@gmail.com"
-  phone = ""
   address = "Durham, UK"
   googlemaps = "https://www.google.com/maps/embed/v1/place?q=place_id:ChIJwbHYJaUqfEgRK0Ui9dVGimc&key=AIzaSyAE_4rVAKux_DSPcb_OdSRDaovtPOSk_3U"
 
+[markup]
+  [markup.highlight]
+    codeFences = true
+    guessSyntax = false
+    hl_Lines = ""
+    lineNoStart = 1
+    lineNos = true
+    lineNumbersInTable = true
+    noClasses = true
+    style = "rainbow_dash"
+    tabWidth = 4
+
diff --git a/exampleSite/content/about/_index.md b/exampleSite/content/about/_index.md
index e78173d..5d3e936 100644
--- a/exampleSite/content/about/_index.md
+++ b/exampleSite/content/about/_index.md
@@ -4,11 +4,10 @@ date: 2019-05-12T12:14:34+06:00
 description: "This is meta description."
 author : "Sam Robbins"
 authorImage : "images/about/profile.jpg"
-authorSignature : "images/about/signature.png"
 ---
 
 Hi! I'm Sam, a second year Computer Science student from Durham University. 
 I like doing personal projects, which you will find in the portfolio page of this website. 
 My specialties can be found on the homepage, of which most are web development or cyber security.
 
-I am currently available for part time remote work, but will be looking for full time employment from summer 2021.
\ No newline at end of file
+I am currently available for part time remote work, but will be looking for full time employment from summer 2021.
diff --git a/exampleSite/content/portfolio/DurHack 2019.md b/exampleSite/content/portfolio/DurHack 2019.md
deleted file mode 100644
index c3a5d93..0000000
--- a/exampleSite/content/portfolio/DurHack 2019.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: Durhack 2019
-date: 2020-01-01T15:19:11.000+00:00
-image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591809232/durhack2019_xb9ycc.png
-categories:
-- web-dev
-- hackathon
-description: My project created at DurHack 2019
-type: post
-coders:
-- samrobbins85
-- tomnudd
-- karina-talibzhanova
-- MAGGithub1
-github: https://github.com/tomnudd/durhack
-
----
-![](https://res.cloudinary.com/samrobbins/image/upload/v1591793300/images/portfolio/images_portfolio_durhack2019_pyn6xr.png)
-
-Our project was to build a tool to help people with dementia remember things, this is implemented in various ways, as described below.
-
-### Capital One
-
-For this, we used the Capital One API to model new transactions coming in and checking if repeat payments are being made. This is done by checking the location and cost of the payment against the previous payments. The reason why this would be useful is that for people with dementia they may forget that they have already bought things, and so buy it again, wasting money. This will allow them to save money by giving them a guess as to if they have already bought that item
-
-### Twilio
-
-We use Twilio to notify the person about important things they should remember. We simplified this process by creating a one-line solution to sending a message through Twilio to any phone number.
-
-### MongoDB hosted on the Google Cloud
-
-We store user account data on the Google Cloud and authenticate users with Auth0. The database also stores information about each user, such as their hobbies and interests, to help them retain their sense of self despite memory loss.
\ No newline at end of file
diff --git a/exampleSite/content/portfolio/hugo-portfolio-website.md b/exampleSite/content/portfolio/hugo-portfolio-website.md
new file mode 100644
index 0000000..0e7bb2c
--- /dev/null
+++ b/exampleSite/content/portfolio/hugo-portfolio-website.md
@@ -0,0 +1,269 @@
++++
+categories = ["web-dev"]
+coders = []
+date = 2020-06-19T23:00:00Z
+description = "A portfolio website made with Hugo"
+github = ["https://github.com/samrobbins85/hugo-developer-portfolio", "https://github.com/samrobbins85/portfolio-website"]
+image = "https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1591793276/logos/logos_hugo_h2xbne.svg"
+title = "Hugo Portfolio Website"
+type = "post"
+[[tech]]
+logo = "https://res.cloudinary.com/samrobbins/image/upload/v1591793276/logos/logos_hugo_h2xbne.svg"
+name = "Hugo"
+url = "https://gohugo.io/"
+[[tech]]
+logo = "https://res.cloudinary.com/samrobbins/image/upload/v1591793279/logos/logos_uikit_irc5gp.svg"
+name = "UIkit"
+url = "https://getuikit.com/"
+[[tech]]
+logo = "https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1593603175/forestry-pos-full_lid6rs.svg"
+name = "Forestry CMS"
+url = "https://forestry.io/"
+
++++
+I created my portfolio website using Hugo and UIKit, it serves as an online resume containing all my work.
+
+This has been created as a theme so that others can use and adapt it.
+
+## Sections
+
+### Homepage
+
+![Homepage Screenshot](https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1591885280/screenshot_aexm2m.png "Homepage Screenshot")
+
+The homepage provides the basic information about you, including links to social media, skills you have, things you've done and your education. This page makes good use of UIKit grid and cards for organising all the information and ensuring it is responsive to work on mobile devices. The hackathon section of this page uses code from [https://github.com/web-tiki/responsive-grid-of-hexagons](https://github.com/web-tiki/responsive-grid-of-hexagons "https://github.com/web-tiki/responsive-grid-of-hexagons") to ensure that the hexagons tile correctly.
+
+### About
+
+![About Screenshot](https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1592844637/Screenshot_2020-06-22_Sam_Robbins_1_xop4uu.png "About Screenshot")
+
+This is the page for a description about you, along with non-technical skills. This uses UIKit grid and cards in a very similar way to the homepage.
+
+### Blog
+
+![](https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1593263737/Screenshot_2020-06-27_Sam_Robbins_koy2no.png)
+
+If you want to have a blog, this page will serve that purpose. I may end up changing this to a column view rather than a column view in the future, but for the present I think it looks fine.
+
+### Portfolio
+
+![](https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1593263791/Screenshot_2020-06-27_Sam_Robbins_1_xa3yvj.png)
+
+This allows you to describe the projects you have created in order to showcase them to people looking at your site.
+
+### Contact
+
+![](https://res.cloudinary.com/samrobbins/image/upload/q_auto/v1593263826/Screenshot_2020-06-27_Sam_Robbins_ce7qsx.png)
+
+This provides a simple contact form which allows users of the site to send you a message. I implemented this using [https://formspree.io/](https://formspree.io/ "https://formspree.io/") as it has a generous free plan and is very simple to integrate.
+
+## Installation
+
+### Integrating into your site
+
+To install this theme, first create a themes folder in your site with
+
+```bash
+mkdir themes
+```
+
+Then move into this directory with
+
+```bash
+cd themes
+```
+
+The repository can then be added either by cloning or adding as a submodule
+
+```bash
+# Cloning
+git clone https://github.com/samrobbins85/hugo-developer-portfolio hugo-developer-portfolio
+# Submodule
+git submodule add https://github.com/samrobbins85/hugo-developer-portfolio hugo-developer-portfolio
+```
+
+In the `config.toml` file in your site directory add
+
+```toml
+theme="hugo-developer-portfolio"
+```
+
+### Creating a new site
+
+If you just want to get set up with a new site, you can start from the Example Site I have provided. To do this:
+
+1. Cut the `exampleSite` folder out of the theme and paste it wherever you want
+2. Create a `theme` directory within the `exampleSite folder`
+3. Paste the theme into this directory, ensuring is has the name `hugo-developer-portfolio`
+
+## CMS
+
+For the content management system I have used Forestry CMS. This provides great flexibility for adding and editing content and integrates great with Hugo as it commits markdown files directly to GitHub.
+
+## Configuration
+
+This is a highly configurable site, and as such, it will be unlikely that it will work with your existing site.
+
+### Config.toml
+
+`Config.toml` provides the basic structure of the site, it contains a range of sections
+
+#### Base information
+
+In the example site, the base information looks as follows
+
+```toml
+baseURL = "http://example.com" # The URL of your site
+languageCode = "en-gb" # The language you want to display the site in
+title = "Sam Robbins" # The title you want to appear in the address bar
+theme = "hugo-developer-portfolio" # The theme, don't change this
+```
+
+#### Plugins
+
+These are the essential plugins required to run the site, but you can add more if you need
+
+```toml
+[params.plugins]
+  # CSS Plugins
+  [[params.plugins.css]]
+  URL = "https://cdn.jsdelivr.net/npm/uikit@3.2.6/dist/css/uikit.min.css"
+  # JS Plugins
+  [[params.plugins.js]]
+  URL = "https://cdn.jsdelivr.net/npm/uikit@3.2.6/dist/js/uikit.min.js"
+  [[params.plugins.js]]
+  URL = "https://cdn.jsdelivr.net/npm/uikit@3.2.6/dist/js/uikit-icons.min.js"
+```
+
+#### Navigation
+
+This specifies the titles for the entries in the taskbar. `name` can be changed to show a different name. `URL` should not be changed in most situations as the pages will exist at the old URLs rather than the new ones, so this will result in dead links.
+
+```toml
+# navigation
+[menu]
+  [[menu.main]]
+  name = "About"
+  URL = "about"
+  [[menu.main]]
+  name = "Blog"
+  URL = "blog"
+  [[menu.main]]
+  name = "Portfolio"
+  URL = "portfolio"
+  [[menu.main]]
+  name = "Contact"
+  URL = "contact"
+```
+
+#### Params
+
+This contains the other configuration information
+
+```toml
+[params]
+home = "Home" # What you want the homepage to show up as in the menu bar
+# Meta data
+description = "The website of Sam Robbins, 2nd Year Computer Science Student at Durham University"
+author = "Sam Robbins"
+
+
+  [params.contact]
+  formAction = "https://formspree.io/<Insert code>" # Add your formspree URL here to get emails
+
+  # This contains the contact information for the footer
+  [params.footer]
+  email = "samrobbinsgb@gmail.com"
+  address = "Durham, UK"
+  googlemaps = "https://www.google.com/maps/embed/v1/place?q=place_id:ChIJwbHYJaUqfEgRK0Ui9dVGimc&key=AIzaSyAE_4rVAKux_DSPcb_OdSRDaovtPOSk_3U"
+```
+
+### homepage.yml
+
+This file is stored in `data/homepage.yml`. It determines the content of the homepage and contains many sections
+
+#### banner
+
+This is the text in the hero section, change it to whatever you want
+
+```yml
+banner:
+  title: Hi! I’m Sam
+```
+
+#### social
+
+Put all of your social links here and they will appear in the social section
+
+```yml
+social:
+  twitter: ""
+  linkedin: sam-robbins-gb
+  github: samrobbins85
+  gitlab: ""
+  facebook: ""
+  instagram: ""
+  gmail: samrobbinsgb
+```
+
+#### about
+
+* `enable` can be used to hide this section
+* `content` determines what text is shown here
+* `btnText` changes the text on the button
+* `URL` changes the URL the button directs to
+
+```yml
+about:
+  enable: true
+  content: 2nd Year Durham Computer Science Student
+  button:
+    btnText: Find out more
+    URL: "/about"
+```
+
+#### skill
+
+* `enable` can be used to hide this section
+* `title` determines the text both under the image and in the modal
+* `logo` determines the image that shows up
+* `description` is the text that appears inside the modal
+
+```yml
+skill:
+  enable: true
+  item:
+    - title: JavaScript
+      logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793272/logos/logos_javascript_adj1dx.svg
+      description: Details coming soon, contact me if you want to know more
+```
+
+#### experience
+
+* `enable` can be used to hide this section
+* `logo` determines the image that shows up
+* `title` is the main text that appears in the card
+* `company` is the secondary text in the card
+* `duration` is the tertiary text in the card
+
+```yml
+experience:
+  enable: true
+  item:
+    - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793271/logos/logos_google_id6v9a.svg
+      title: init.g
+      company: Google
+      duration: November 2019
+```
+
+#### hackathons
+
+```yml
+hackathons:
+  enable: true
+  item:
+    - title: Hack Cambridge 2019
+      description: Climate change simulator
+      image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793405/stickers/Hack_Cambridge_101_ozoq5d.png
+      url: javascript:void(0)
+```
\ No newline at end of file
diff --git a/exampleSite/data/homepage.yml b/exampleSite/data/homepage.yml
index 825d1fc..4a375d4 100644
--- a/exampleSite/data/homepage.yml
+++ b/exampleSite/data/homepage.yml
@@ -21,21 +21,6 @@ skill:
   - title: JavaScript
     logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793272/logos/logos_javascript_adj1dx.svg
     description: Details coming soon, contact me if you want to know more
-  - title: Python
-    description: Details coming soon, contact me if you want to know more
-    logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793276/logos/logos_python_pjlesq.svg
-  - title: Vercel
-    description: Details coming soon, contact me if you want to know more
-    logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793280/logos/logos_zeit_mj2mka.svg
-  - title: LaTeX
-    description: Details coming soon, contact me if you want to know more
-    logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793272/logos/logos_latex_jy4wnp.svg
-  - title: Linux
-    description: Details coming soon, contact me if you want to know more
-    logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793274/logos/logos_linux_btjirt.svg
-  - title: Hugo
-    description: Details coming soon, contact me if you want to know more
-    logo: https://res.cloudinary.com/samrobbins/image/upload/v1591793276/logos/logos_hugo_h2xbne.svg
 experience:
   enable: true
   item:
@@ -43,32 +28,19 @@ experience:
     title: init.g
     company: Google
     duration: November 2019
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793275/logos/logos_pmt_tdrgcd.webp
-    title: Web Developer
-    company: Physics and Maths Tutor
-    duration: October 2019 - Present
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793274/logos/logos_nexus_i7azpj.webp
-    title: Work Experience
-    company: Nexus
-    duration: July 2017
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793274/logos/logos_nustem_l2nwbm.webp
-    title: Work Experience
-    company: nustem
-    duration: March 2015 - April 2015
 hackathons:
+  enable: true
   item:
   - title: Hack Cambridge 2019
     description: Climate change simulator
     image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793405/stickers/Hack_Cambridge_101_ozoq5d.png
-    url: javascript:void(0)
-  - title: DurHack 2019
-    description: Dementia Helper
-    image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793399/stickers/durhack19_dzecbb.png
-    url: "/portfolio/durhack-2019/"
-  - title: DurHack 2018
-    description: Cult Bot
-    image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793396/stickers/durhack18_k2atqm.png
-    url: javascript:void(0)
+    url: none
+certifications:
+  enable: true
+  item:
+  - title: Microsoft Azure Fundamentals
+    image: https://res.cloudinary.com/samrobbins/image/upload/v1592501459/microsoft-certified-fundamentals-badge_cpcgyn.svg
+    url: https://www.youracclaim.com/badges/b4cf7a86-eb83-478e-bfd0-9f427c3474a0/public_url
 education:
   enable: true
   item:
@@ -76,12 +48,6 @@ education:
     year: 2018 - Present
     academy: Durham University
     image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793268/logos/logos_Durham_fc2sae.svg
-  - title: GCSEs and A Levels
-    year: 2013-2018
-    academy: The King Edward VI School
-    image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793272/logos/logos_kevi_ksyppz.webp
-blog:
-  enable: true
 leadership:
   enable: true
   item:
@@ -89,15 +55,3 @@ leadership:
     title: Young Leader
     company: The Scout Association
     duration: September 2014 - July 2018
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793272/logos/logos_kevi_ksyppz.webp
-    title: Leader of the Space Club
-    company: The King Edward VI School
-    duration: April 2017 - April 2018
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793271/logos/logos_explorerbelt_ezjvqq.webp
-    title: Explorer Belt
-    company: The Scout Association
-    duration: August 2016
-  - logo: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793271/logos/logos_dofe_j7lpeh.webp
-    title: Bronze and Silver DofE
-    company: The Duke of Edinburgh's Award
-    duration: June 2014 - January 2017
diff --git a/exampleSite/package.json b/exampleSite/package.json
index 6e20c58..a9f03e9 100644
--- a/exampleSite/package.json
+++ b/exampleSite/package.json
@@ -1,6 +1,6 @@
 {
   "scripts": {
-    "build": "rm -rf themes/hugo-developer-portfolio;git clone https://github.com/samrobbins85/hugo-developer-portfolio.git themes/hugo-developer-portfolio && hugo"
+    "build": "hugo"
   }
 }