Merge pull request MLH#19 from dtemir/fix-stylesheet-reference

Fix stylesheet reference

.gitignore

@@ -1,5 +1,7 @@
 _site
 .sass-cache
 .jekyll-metadata
+.jekyll-cache
 node_modules/
 .DS_Store
+Gemfile.lock

.ruby-version

@@ -1 +1 @@
-2.2.4
+2.7.0

Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-ruby "2.2.4"
+ruby "2.7.0"
 
 gem "jekyll"
 gem "jekyll-watch"

README.md

@@ -17,19 +17,32 @@ Advantages:
 
 ## Getting Started
 
-1. Create a [GitHub][create-account] account if you haven't already.
-2. Fork this repository to your own account. [Click here to fork this repo][fork-repo].
-3. Edit [`_config.yml`][config] to configure for your own hackathon website.
+1. Create a [GitHub][create-account] account if you haven't already
+2. Fork this repository to your own account. [Click here to fork this repo][fork-repo]
+3. Edit [`_config.yml`][config] to configure for your own hackathon website
 4. That's it - you should be able to access at `https://[github username].github.io/mlh-hackathon-boilerplate/`
 
 [create-account]: https://github.com/join
 [fork-repo]: https://github.com/MLH/mlh-hackathon-boilerplate/fork
 
+### Run Locally
+
+If you would like to populate and test the website locally, follow these steps:
+
+1. Install Jekyll prerequisites by following one of the [guides][jekyll-guides]
+2. Install Jekyll and bundler gems `gem install jekyll bundler`
+3. Build and serve the site locally `bundle exec jekyll serve`
+4. Head over to [http://localhost:4000/][localhost]
+5. Make sure everything looks good 
+
+[jekyll-guides]: https://jekyllrb.com/docs/installation/
+[localhost]: http://localhost:4000/
+
 ### Setting up a custom domain
 
 Want to configure for your own custom domain? Great! Through our excellent partners [Domain.com][domain-com], Major League Hacking is offering free domains to student hackathon organizers. Reach out to [[email protected]][email-mlh] to obtain your free coupon code.
 
-1. Register your domain.
+1. Register your domain
 2. Update the domain `www` to `CNAME [github username].github.io`
 3. Update the domain `@` to `A 192.30.252.153` and `A 192.30.252.154`
 4. Update the `CNAME` in your GitHub fork of `mlh-hackathon-boilerplate` to your new domain (i.e. `examplehacks.com`)
@@ -42,14 +55,18 @@ Want to configure for your own custom domain? Great! Through our excellent partn
 
 ### Setting up SSL
 
-We'd highly recommend looking into [Cloudflare][cloudflare] for SSL with your domain. It's compatible with [GitHub Pages][github-pages] and this project.
+GitHub Pages now provides you with an option to Enforce HTTPS which will create an SSL certificate for you. All you need is to select the Enforce HTTPS checkmark when setting up custom domain in the step above.
+
+Give the process some time, but if it has not completed after several minutes, click **Remove** next to your domain name, retype the domain name, and then click **Save**. This will restart the SSL issuing process.
+
+If you setup HTTPS correctly, make sure you do not refernece HTTP anywhere on your website. Servinig [mixed][mixed] content will make your website less secure.
 
-[cloudflare]: https://cloudflare.com
+[mixed]: https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https#resolving-problems-with-mixed-content
 
 ## Contributing
 
 Our boilerplate is written entirely in [Jekyll][jekyll], which GitHub automatically compiles. This dramatically reduces the technical barrier needed to setup a hackathon website. We'd love to receive your contributions towards making this even better. A couple of things to note:
 
-- We can't accept custom plugins because it's not supported by [GitHub Pages][github-pages].
-- If adding any external images or components, please ensure you have the correct permission to use them.
-- We advise creating a GitHub issue first explaining the issue.
+- We can't accept custom plugins because it's not supported by [GitHub Pages][github-pages]
+- If adding any external images or components, please ensure you have the correct permission to use them
+- We advise creating a GitHub issue first explaining the issue

_config.yml

@@ -2,9 +2,14 @@
 # -- Settings --
 # --------------
 
-# Ignore this. This is only if you're hosting this in a sub-folder.
-# If you're using GitHub pages, they automatically override this with the right value.
-baseurl: ""
+# If you are hosting in a sub-folder, for example: https://mlh.github.io/mlh-hackathon-boilerplate/,
+# you must specify it as the baseurl
+# If you hosting as a root, for example: htttps://[github username].github.io, then leave it blank
+baseurl: "/mlh-hackathon-boilerplate"
+
+# uncomment the next line if you are hosting as a root and not sub-folder
+# for example, when runnig locally at http://127.0.0.1:4000/
+# baseurl: ""
 
 # If you're using GitHub pages without a custom domain, this is "https://[github username].github.io"
 # If you're using GitHub pages with a custom domain, this is "http://[your domain]" (or https if you're using SSL)
@@ -24,15 +29,15 @@ social:
 
 # This is Search Engine Optimization. It'll help your website look better on search.
 seo:
-  title:       "Example Hacks | 5/6 August 2016"
+  title:       "Example Hacks | 5-6 August 2022"
   description: "This is a sample hackathon website that you can use by following instructions on GitHub."
   image:       "https://prime.mlh.io/img/logos/mlh-prime-color.svg"
 
 # Event information.
 event:
   name:        "Example Hacks"
   description: "This is a sample hackathon website that you can use by following instructions on GitHub."
-  date:        "5 & 6 August 2016"
+  date:        "5 - 6 August 2022"
   location:    "Holmdel, NJ, United States"
 
   trust_badge:

_includes/head.html

@@ -26,12 +26,12 @@
   <!-- Stylesheets -->
   <link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Open+Sans:400,300,700,300italic,400italic,700italic" />
   <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css">
-  <link rel="stylesheet" type="text/css" href="{{ '/css/bootstrap.min.css' | prepend: site.baseurl | prepend: site.url }}" />
-  <link rel="stylesheet" type="text/css" href="{{ '/css/base.css' | prepend: site.baseurl | prepend: site.url }}" />
-  <link rel="stylesheet" type="text/css" href="{{ '/css/' | prepend: site.baseurl | prepend: site.url }}{{ site.style.theme | append: '.css' }}" />
+  <link rel="stylesheet" type="text/css" href="{{ '/css/bootstrap.min.css' | relative_url }}" />
+  <link rel="stylesheet" type="text/css" href="{{ '/css/base.css' | relative_url }}" />
+  <link rel="stylesheet" type="text/css" href="{{ '/css/' | relative_url }}{{ site.style.theme | append: '.css' }}" />
   <!-- link rel="icon" href="/img/favicon.ico" -->
 
   <!-- Favicon -->
   <link rel="canonical" href="{{ page.url | replace: 'index.html', '' | prepend: site.baseurl | prepend: site.url }}">
-  <link rel="icon"      href="{{ '/img/favicon.ico' | prepend: site.baseurl | prepend: site.url }}">
+  <link rel="icon"      href="{{ '/images/favicon.ico' | prepend: site.baseurl | prepend: site.url }}">
 </head>