Skip to content

Commit

Permalink
docs: Add basic microsite with simple privacy policy (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbmorley authored Oct 13, 2023
1 parent 7325682 commit f60a4ab
Show file tree
Hide file tree
Showing 13 changed files with 333 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
build
docs/_site
docs/.jekyll-cache
fastlane/.env
fastlane/report.xml
.local
Expand Down
25 changes: 25 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
permalink: /404.html
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page Not Found</strong></p>
<p>The requested page could not be found.</p>
</div>
32 changes: 32 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "~> 4.2.0"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]


gem "webrick", "~> 1.7"
84 changes: 84 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
forwardable-extended (2.6.0)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
jekyll (4.2.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-feed (0.16.0)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.0)
rb-fsevent (0.11.1)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.30.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.8.0)
webrick (1.7.0)

PLATFORMS
x86_64-darwin-20
x86_64-darwin-22
x86_64-linux

DEPENDENCIES
jekyll (~> 4.2.0)
jekyll-feed (~> 0.12)
minima (~> 2.5)
tzinfo (~> 1.2)
tzinfo-data
wdm (~> 0.1.1)
webrick (~> 1.7)

BUNDLED WITH
2.2.18
59 changes: 59 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: Overview
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: jekyllrb
github_username: jekyll

# Build settings
theme: minima
plugins:
- jekyll-feed

defaults:
- values:
layout: "default"

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
5 changes: 5 additions & 0 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<div class="footer">
<p class="copyright">
&copy; 2021-2023 <a href="https://jbmorley.co.uk" target="_blank">Jason Barrie Morley</a>
</p>
</div>
5 changes: 5 additions & 0 deletions docs/_includes/navigation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<ul class="navigation">
<li><a href="/">Overview</a></li>
<li><a href="/privacy-policy">Privacy Policy</a></li>
<li><a href="https://github.com/inseven/overview" target="_blank">GitHub</a></li>
</ul>
19 changes: 19 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{{ site.title }}{% if page.title %} - {{ page.title }}{% endif %}</title>
{% if page.description %}<meta name="description" content="{{ page.description }}">{% endif %}
{% if site.author %}<meta name="author" content="{{ site.author }}">{% endif %}
<link rel="stylesheet" href="/css/style.css">
<meta property="og:title" content="{{ site.title }}{% if page.title %} - {{ page.title }}{% endif %}">
</head>
<body>
{% include navigation.html %}
<div class="content">
{{ content }}
</div>
{% include footer.html %}
</body>
</html>
79 changes: 79 additions & 0 deletions docs/css/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
:root {
--tint-color: color(display-p3 0.946 0.64 0.263);
--brand-color: color(display-p3 0.946 0.64 0.263);
--body-color: #000000;
--content-width: 800px;
--vertical-spacing: 1.5em;
}

body {
font-family: Helvetica, sans-serif;
font-weight: 200;
margin: 0;
color: var(--body-color);
}

a {
text-decoration: underline;
color: var(--body-color);
}

a:hover {
color: var(--brand-color);
}

ul.navigation {
list-style: none;
margin: 0;
padding: 1em;
background-color: white;
position: sticky;
top: 0;
width: 100%;
z-index: 1000;
box-sizing: border-box;
font-weight: 400;
text-align: center;
}

ul.navigation a {
text-decoration: none;
}

ul.navigation > li {
display: inline-block;
padding: 0.4em;
}

.header {
text-align: center;
}

.content {
max-width: var(--content-width);
margin: auto;
padding: 2em;
font-size: 1.1em;
line-height: var(--vertical-spacing);
}

.tagline {
text-align: center;
font-size: 1.4em;
font-weight: 400;
}

.footer {
max-width: var(--content-width);
margin: auto;
padding: 2em;
}

.copyright {
text-align: center;
}

h1 {
text-align: center;
font-size: 3em;
}
Binary file added docs/images/icon_128x128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/index.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: About
---

<p class="header">
<img src="/images/icon_128x128.png"
srcset="/images/icon_128x128.png, /images/[email protected] 2x"
width="128"
height="128" />
</p>

# Overview

<p class="tagline">Generate monthly calendar summaries</p>
9 changes: 9 additions & 0 deletions docs/privacy-policy/index.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Privacy Policy
---

# Privacy Policy

Overview does not collect or store any personal data. All events and reports remain local to your device.

Should this policy change in the future, we will make all reasonable efforts to inform you and provide mechanisms to opt-out.

0 comments on commit f60a4ab

Please sign in to comment.