Skip to content

Commit

Permalink
Setup docs jekyll site
Browse files Browse the repository at this point in the history
  • Loading branch information
BilledTrain380 committed Nov 21, 2018
1 parent 6aac852 commit 9c89ac4
Show file tree
Hide file tree
Showing 18 changed files with 869 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_site
.sass-cache
.jekyll-metadata
24 changes: 24 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
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>
30 changes: 30 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
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", "~> 3.7.4"

# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.0"

# 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.6"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.0" if Gem.win_platform?

74 changes: 74 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
colorator (1.1.0)
concurrent-ruby (1.1.3)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.9.25)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.7.4)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-feed (0.11.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.5.0)
jekyll (~> 3.3)
jekyll-watch (2.1.2)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.1)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
minima (2.5.0)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.0.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.3.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.7.2)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)

PLATFORMS
ruby

DEPENDENCIES
jekyll (~> 3.7.4)
jekyll-feed (~> 0.6)
minima (~> 2.0)
tzinfo-data

BUNDLED WITH
1.17.1
42 changes: 42 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 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.

# 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: Your awesome title
email: your-email@example.com
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
markdown: kramdown
plugins:
- jekyll-feed

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
# - Gemfile
# - Gemfile.lock
# - node_modules
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
8 changes: 8 additions & 0 deletions docs/_data/tour.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
items:
- img: ""
title: "Import groups"
description: "Simple import groups via a csv file."

- img: ""
title: "Select sport"
description: "Simple select the sport where bla bla bla"
95 changes: 95 additions & 0 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<footer class="bg-dark text-light pt-5">

<div class="container">

<div class="row">

<div class="col-lg-3">

<img width="30" height="30" src="{{ site.url }}/img/psa-logo.svg">
<p>
<small class="text-muted">2018 - 2019</small>
</p>

</div>

<div class="col-lg-3">

<h5>Features</h5>

<ul class="list-unstyled text-small">
<li><a class="text-muted" href="#">CSV Import</a></li>
<li><a class="text-muted" href="#">Participant Managing</a></li>
<li><a class="text-muted" href="#">Event Sheet Export</a></li>
<li><a class="text-muted" href="#">Result Recording</a></li>
<li><a class="text-muted" href="#">Ranking Export</a></li>
<li><a class="text-muted" href="#">User Managing</a></li>
<li><a class="text-muted" href="#">LTR and RTL Support</a></li>
</ul>

</div>

<div class="col-lg-3">

<h5>Downloads</h5>

<ul class="list-unstyled text-small">
<li><a class="text-muted" href="#">UI Mode</a></li>
<li><a class="text-muted" href="#">Headless Mode</a></li>
</ul>

</div>

<div class="col-lg-2">

<h5>Support</h5>

<ul class="list-unstyled text-small">
<li><a class="text-muted" href="#">Installation</a></li>
<li><a class="text-muted" href="#">Roadmap</a></li>
<li><a class="text-muted" href="#">Archive</a></li>
</ul>

</div>

<div class="col-lg-1">

<h5 class="float-right"><a class="text-light" href="#">About</a></h5>

</div>

</div>

</div>

<hr class="hr-light">

<div class="container">

<div class="row">

<div class="col-lg-8">

<p class="text-muted">
Designed and built in cooperation with <a href="https://www.schule-altendorf.ch/" target="_blank">Primarschule Altendorf</a>.
<br/>
Currently 1.0.0+psa.2.0.0.1.0.0 Code licensed GPLv3, docs CC BY 3.0
</p>

</div>

<div class="col-lg-4">

<div class="float-right">
<a class="nav-link text-muted pr-0" href="https://github.com/BilledTrain380/sporttag-psa" target="_blank">
<i class="fab fa-2x fa-github"></i>
</a>
</div>

</div>

</div>

</div>

</footer>
100 changes: 100 additions & 0 deletions docs/_includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<head>
<meta charset="UTF-8">
<title>{{ page.title }} - PSA</title>

<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css"
rel="stylesheet"
integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO"
crossorigin="anonymous">

<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.5.0/css/all.css"
integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU"
crossorigin="anonymous">

<script
src="https://code.jquery.com/jquery-3.3.1.min.js"
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
crossorigin="anonymous"></script>

<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js"
integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy"
crossorigin="anonymous"></script>

<style>

.feature-item {
margin-top: 30px;
margin-bottom: 30px;
}

.bg-dark {
background-color: #111218!important;
}

hr.hr-light {
border: 0;
height: 0;
border-top: 1px solid rgba(0, 0, 0, 0.1);
border-bottom: 1px solid rgba(255, 255, 255, 0.3);
}

.tour-skip-button {
position: absolute;
top: 20px;
right: 20px
}

.tour-title {
position: absolute;
top: 20px;
left: 20px;
}

.tour-exit {
position: absolute;
top: 20px;
left: 50%;
transform: translate(-50%, 0);
}

.tour-container {
display: flex;
flex-direction: column;
height: 100%;
}

.tour-container .tour-item {
margin-left: 20px;
margin-right: 20px;
margin-top: 60px;
overflow: hidden;
}

.tour-container .tour-item:last-child {
margin-bottom: 60px;
}

.tour-container .tour-item.f-1 {
flex: 1
}

.tour-container .tour-item.f-2 {
flex: 2
}

.tour-container .tour-item.f-3 {
flex: 3
}

.tour-container .tour-item.f-4 {
flex: 4
}

.carousel-indicators.round li {
height: 30px;
width: 30px;
border-radius: 30px;
}

</style>
</head>
Loading

0 comments on commit 9c89ac4

Please sign in to comment.