Merge pull request #43 from sbliven/cleanup

Miscelaneous cleanup

README.md

@@ -0,0 +1,43 @@
+# SciCat Project website
+
+This repository contains all the files that are needed to generate the SciCat homepage.
+It is that is hosted using github pages at https://scicatproject.github.io/. Source
+code can be cloned from [github](https://github.com/SciCatProject/scicatproject.github.io).
+
+In addition to the homepage, the technical documentation served under `/documentation`
+and hosted in the [SciCatProject/documentation](https://github.com/SciCatProject/documentation)
+repository.
+
+# Building
+
+The site is generated using [jekyll](https://jekyllrb.com/). It is typically built by
+github directly, but can also be run locally for testing.
+
+## Running locally with ruby
+
+If you have ruby installed you can run jekyll locally:
+
+```bash
+gem install bundler jekyll
+ bundle exec jekyll serve
+```
+
+## Running with docker
+
+You may prefer to build using a docker container to avoid installing all the dependencies.
+This can be done by simply running the following from the project directory:
+
+```bash
+docker-compose up
+```
+
+This will serve the site at http://localhost:4000. Most changes live-update, with the
+exception of changes to `_config.yml`.
+
+
+# Resources
+- https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll
+- https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll
+- https://medium.com/codex/how-to-add-bootstrap-5-to-jekyll-in-two-easy-ways-4d9dd3c8c895
+- https://github.com/jekyll/jekyll/issues/8523
+- https://github.com/actions/jekyll-build-pages

_includes/header.html

@@ -3,7 +3,7 @@
  <div class="container">
   <div class="row">
    <div class="col-xl-9 mx-auto">
-    <img src="assets/images/SciCat_logo_full_950x460.png">
+    <img src="{{ '/assets/images/SciCat_logo_full_950x460.png' | releative_url }}">
     <h1 class="mb-5">{{ site.slogan }}</h1>
    </div>
   </div>

_includes/nav.html

@@ -58,30 +58,32 @@
 <nav class="navbar fixed-top affix-top navbar-expand-lg navbar-light bg-light navbar-fixed-top">
  <div class="container-fluid">
   <div class="navbar-header">
-   <a id="nav-logo" class="navbar-brand" href="#"><img src="assets/images/SciCat_logo_full_100x48.png"></a>
+   <a id="nav-logo" class="navbar-brand" href="#"><img src="{{ '/assets/images/SciCat_logo_full_100x48.png' | releative_url }}"></a>
    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
     <span class="navbar-toggler-icon"></span>
    </button>
   </div>
   <div class="navbar-menu collapse navbar-collapse justify-content-center" id="navbarSupportedContent">
    <ul class="nav navbar-nav nav-pills mb-2 mb-lg-0">
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link active" id="nav-link-home" aria-current="page" href="#" onclick="onClick(event);">Home</a>
+     <a class="page-scroll nav-link active" id="nav-link-home" aria-current="page" href="{{'#' | relative_url }}" onclick="onClick(event);">Home</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-intro" href="#intro" onclick="onClick(event);">Intro</a>
+     <a class="page-scroll nav-link" id="nav-link-intro" href="{{'#intro' | relative_url }}" onclick="onClick(event);">Intro</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-facilities" href="#facilities" onclick="onClick(event);">Facilities</a>
+     <a class="page-scroll nav-link" id="nav-link-facilities" href="{{'#facilities' | relative_url }}" onclick="onClick(event);">Facilities</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-team" href="#team" onclick="onClick(event);">Team</a>
+     <a class="page-scroll nav-link" id="nav-link-team" href="{{'#team' | relative_url }}" onclick="onClick(event);">Team</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-effort" href="#effort" onclick="onClick(event);">Effort</a>
+     <a class="page-scroll nav-link" id="nav-link-effort" href="{{'#effort' | relative_url }}" onclick="onClick(event);">Effort</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-resources" href="#resources" onclick="onClick(event);">Resources</a>
+     <a class="page-scroll nav-link" id="nav-link-resources" href="{{'#resources' | relative_url }}" onclick="onClick(event);">Resources</a>
+    <li class="nav-item mx-lg-3">
+     <a class="page-scroll nav-link" href="https://scicatproject.github.io/documentation/" target="_blank" onclick="onClick(event);">Docs</a>
     </li>
   </div>
 </nav>

_layouts/page.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>{{ site.title }}</title>
+  <link rel="stylesheet" href="/assets/css/bootstrap.min.css">
+  <script src="/assets/js/bootstrap.min.js"></script>
+  <link rel="stylesheet" href="/assets/css/styles.css">
+  <link href="https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic" rel="stylesheet" type="text/css">
+  <link href="assets/fontawesome-free-6.4.2-web/css/all.min.css" rel="stylesheet">
+</head>
+<body>
+  {% include nav.html %}
+  <div class="container">
+    <div class="row">
+      <h1 class="mt-5 mb-5">{{ page.title }}</h1>
+{{ content }}
+    </div>
+  </div>
+  {% include breaker.html %}
+  {% include footer.html %}
+  <script src="/assets/js/main.js"></script>
+</body>
+</html>

docker-compose.yaml

@@ -0,0 +1,9 @@
+version: '3'
+services:
+  serve:
+    image: jekyll/jekyll:latest
+    command: jekyll serve --watch --force_polling --verbose
+    ports:
+      - 4000:4000
+    volumes:
+      - .:/srv/jekyll