-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
GitLab
authored and
Marc Schwede
committed
Nov 13, 2019
0 parents
commit 411e1ab
Showing
27 changed files
with
1,045 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
############################################################################### | ||
# Set default behavior to automatically normalize line endings. | ||
############################################################################### | ||
* text=auto | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
_site | ||
.sass-cache | ||
.jekyll-metadata | ||
public/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
image: ruby:2.3 | ||
|
||
variables: | ||
JEKYLL_ENV: production | ||
LC_ALL: C.UTF-8 | ||
|
||
before_script: | ||
- bundle install | ||
|
||
test: | ||
stage: test | ||
script: | ||
- bundle exec jekyll build -d test | ||
artifacts: | ||
paths: | ||
- test | ||
except: | ||
- master | ||
|
||
pages: | ||
stage: deploy | ||
script: | ||
- bundle exec jekyll build -d public | ||
artifacts: | ||
paths: | ||
- public | ||
only: | ||
- master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
source "https://rubygems.org" | ||
ruby RUBY_VERSION | ||
|
||
# This will help ensure the proper Jekyll version is running. | ||
gem "jekyll", "3.4.0" | ||
|
||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem | ||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
addressable (2.5.0) | ||
public_suffix (~> 2.0, >= 2.0.2) | ||
colorator (1.1.0) | ||
ffi (1.9.17) | ||
forwardable-extended (2.6.0) | ||
jekyll (3.4.0) | ||
addressable (~> 2.4) | ||
colorator (~> 1.0) | ||
jekyll-sass-converter (~> 1.0) | ||
jekyll-watch (~> 1.1) | ||
kramdown (~> 1.3) | ||
liquid (~> 3.0) | ||
mercenary (~> 0.3.3) | ||
pathutil (~> 0.9) | ||
rouge (~> 1.7) | ||
safe_yaml (~> 1.0) | ||
jekyll-sass-converter (1.5.0) | ||
sass (~> 3.4) | ||
jekyll-watch (1.5.0) | ||
listen (~> 3.0, < 3.1) | ||
kramdown (1.13.2) | ||
liquid (3.0.6) | ||
listen (3.0.8) | ||
rb-fsevent (~> 0.9, >= 0.9.4) | ||
rb-inotify (~> 0.9, >= 0.9.7) | ||
mercenary (0.3.6) | ||
pathutil (0.14.0) | ||
forwardable-extended (~> 2.6) | ||
public_suffix (2.0.5) | ||
rb-fsevent (0.9.8) | ||
rb-inotify (0.9.8) | ||
ffi (>= 0.5.0) | ||
rouge (1.11.1) | ||
safe_yaml (1.0.4) | ||
sass (3.4.23) | ||
|
||
PLATFORMS | ||
ruby | ||
|
||
DEPENDENCIES | ||
jekyll (= 3.4.0) | ||
tzinfo-data | ||
|
||
RUBY VERSION | ||
ruby 2.3.1p112 | ||
|
||
BUNDLED WITH | ||
1.13.6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
 | ||
 | ||
|
||
--- | ||
|
||
Example [Jekyll] website using GitLab Pages. View it live at https://pages.gitlab.io/jekyll | ||
|
||
[Learn more about GitLab Pages](https://pages.gitlab.io) or read the the [official GitLab Pages documentation](https://docs.gitlab.com/ce/user/project/pages/). | ||
|
||
--- | ||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
||
- [Getting Started](#getting-started) | ||
- [Start by forking this repository](#start-by-forking-this-repository) | ||
- [Start from a local Jekyll project](#start-from-a-local-jekyll-project) | ||
- [GitLab CI](#gitlab-ci) | ||
- [Using Jekyll locally](#using-jekyll-locally) | ||
- [GitLab User or Group Pages](#gitlab-user-or-group-pages) | ||
- [Did you fork this project?](#did-you-fork-this-project) | ||
- [Other examples](#other-examples) | ||
- [Troubleshooting](#troubleshooting) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## Getting Started | ||
|
||
You can get started with GitLab Pages using Jekyll easily by either forking this repository or by uploading a new/existing Jekyll project. | ||
|
||
Remember you need to wait for your site to build before you will be able to see your changes. You can track the build on the **Pipelines** tab. | ||
|
||
### Start by forking this repository | ||
|
||
1. Fork this repository. | ||
1. **IMPORTANT:** Remove the fork relationship. | ||
Go to **Settings (⚙)** > **Edit Project** and click the **"Remove fork relationship"** button. | ||
1. Enable Shared Runners. | ||
Go to **Settings (⚙)** > **Pipelines** and click the **"Enable shared Runners"** button. | ||
1. Rename the repository to match the name you want for your site. | ||
1. Edit your website through GitLab or clone the repository and push your changes. | ||
|
||
### Start from a local Jekyll project | ||
|
||
1. [Install][] Jekyll. | ||
1. Use `jekyll new` to create a new Jekyll Project. | ||
1. Add [this `.gitlab-ci.yml`](.gitlab-ci.yml) to the root of your project. | ||
1. Push your repository and changes to GitLab. | ||
|
||
## GitLab CI | ||
|
||
This project's static Pages are built by [GitLab CI][ci], following the steps | ||
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): | ||
|
||
``` | ||
image: ruby:2.3 | ||
variables: | ||
JEKYLL_ENV: production | ||
pages: | ||
script: | ||
- bundle install | ||
- bundle exec jekyll build -d public | ||
artifacts: | ||
paths: | ||
- public | ||
only: | ||
- master | ||
``` | ||
|
||
## Using Jekyll locally | ||
|
||
To work locally with this project, you'll have to follow the steps below: | ||
|
||
1. Fork, clone or download this project | ||
1. [Install][] Jekyll | ||
1. Download dependencies: `bundle` | ||
1. Build and preview: `bundle exec jekyll serve` | ||
1. Add content | ||
|
||
The above commands should be executed from the root directory of this project. | ||
|
||
Read more at Jekyll's [documentation][]. | ||
|
||
## GitLab User or Group Pages | ||
|
||
To use this project as your user/group website, you will need one additional | ||
step: just rename your project to `namespace.gitlab.io`, where `namespace` is | ||
your `username` or `groupname`. This can be done by navigating to your | ||
project's **Settings**. | ||
|
||
Read more about [user/group Pages][userpages] and [project Pages][projpages]. | ||
|
||
## Did you fork this project? | ||
|
||
If you forked this project for your own use, please go to your project's | ||
**Settings** and remove the forking relationship, which won't be necessary | ||
unless you want to contribute back to the upstream project. | ||
|
||
## Other examples | ||
|
||
* [jekyll-branched](https://gitlab.com/pages/jekyll-branched) demonstrates how you can keep your GitLab Pages site in one branch and your project's source code in another. | ||
* The [jekyll-themes](https://gitlab.com/groups/jekyll-themes) group contains a collection of example projects you can fork (like this one) having different visual styles. | ||
|
||
## Troubleshooting | ||
|
||
1. CSS is missing! That means two things: | ||
* Either that you have wrongly set up the CSS URL in your templates, or | ||
* your static generator has a configuration option that needs to be explicitly | ||
set in order to serve static assets under a relative URL. | ||
|
||
[ci]: https://about.gitlab.com/gitlab-ci/ | ||
[Jekyll]: http://jekyllrb.com/ | ||
[install]: https://jekyllrb.com/docs/installation/ | ||
[documentation]: https://jekyllrb.com/docs/home/ | ||
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages | ||
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# 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 need to edit after that. | ||
# For technical reasons, this file is *NOT* reloaded automatically when you use | ||
# 'jekyll serve'. If you change this file, please restart the server process. | ||
|
||
# Site settings | ||
title: Example Jekyll site using GitLab Pages | ||
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: "/jekyll" # the subpath of your site, e.g. /blog | ||
url: "/" # the base hostname & protocol for your site | ||
twitter_username: jekyllrb | ||
github_username: jekyll | ||
gitlab_username: pages | ||
|
||
# Outputting | ||
permalink: /:categories/:year/:month/:day/:title | ||
|
||
# Build settings | ||
markdown: kramdown | ||
exclude: ["README.md"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<footer class="site-footer"> | ||
|
||
<div class="wrapper"> | ||
|
||
<h2 class="footer-heading">{{ site.title }}</h2> | ||
|
||
<div class="footer-col-wrapper"> | ||
<div class="footer-col footer-col-1"> | ||
<ul class="contact-list"> | ||
<li>{{ site.title }}</li> | ||
<li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li> | ||
</ul> | ||
</div> | ||
|
||
<div class="footer-col footer-col-2"> | ||
<ul class="social-media-list"> | ||
{% if site.gitlab_username %} | ||
<li> | ||
{% include icon-gitlab.html username=site.gitlab_username %} | ||
</li> | ||
{% endif %} | ||
|
||
{% if site.github_username %} | ||
<li> | ||
{% include icon-github.html username=site.github_username %} | ||
</li> | ||
{% endif %} | ||
|
||
{% if site.twitter_username %} | ||
<li> | ||
{% include icon-twitter.html username=site.twitter_username %} | ||
</li> | ||
{% endif %} | ||
</ul> | ||
</div> | ||
|
||
<div class="footer-col footer-col-3"> | ||
<p>{{ site.description }}</p> | ||
</div> | ||
</div> | ||
|
||
</div> | ||
|
||
</footer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
|
||
<title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title> | ||
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}"> | ||
|
||
<link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}"> | ||
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> | ||
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}"> | ||
</head> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<header class="site-header"> | ||
|
||
<div class="wrapper"> | ||
|
||
<a class="site-title" href="{{ site.baseurl }}/">{{ site.title }}</a> | ||
|
||
<nav class="site-nav"> | ||
<a href="#" class="menu-icon"> | ||
<svg viewBox="0 0 18 15"> | ||
<path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/> | ||
<path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/> | ||
<path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/> | ||
</svg> | ||
</a> | ||
|
||
<div class="trigger"> | ||
{% for my_page in site.pages %} | ||
{% if my_page.title %} | ||
<a class="page-link" href="{{ my_page.url | prepend: site.baseurl }}">{{ my_page.title }}</a> | ||
{% endif %} | ||
{% endfor %} | ||
</div> | ||
</nav> | ||
|
||
</div> | ||
|
||
</header> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">{{ include.username }}</span></a> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<a href="https://gitlab.com/{{ include.username }}"><span class="icon icon--gitlab">{% include icon-gitlab.svg %}</span><span class="username">{{ include.username }}</span></a> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<a href="https://twitter.com/{{ include.username }}"><span class="icon icon--twitter">{% include icon-twitter.svg %}</span><span class="username">{{ include.username }}</span></a> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!DOCTYPE html> | ||
<html> | ||
|
||
{% include head.html %} | ||
|
||
<body> | ||
|
||
{% include header.html %} | ||
|
||
<div class="page-content"> | ||
<div class="wrapper"> | ||
{{ content }} | ||
</div> | ||
</div> | ||
|
||
{% include footer.html %} | ||
|
||
</body> | ||
|
||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
layout: default | ||
--- | ||
<article class="post"> | ||
|
||
<header class="post-header"> | ||
<h1 class="post-title">{{ page.title }}</h1> | ||
</header> | ||
|
||
<div class="post-content"> | ||
{{ content }} | ||
</div> | ||
|
||
</article> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
layout: default | ||
--- | ||
<article class="post" itemscope itemtype="http://schema.org/BlogPosting"> | ||
|
||
<header class="post-header"> | ||
<h1 class="post-title" itemprop="name headline">{{ page.title }}</h1> | ||
<p class="post-meta"><time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ page.date | date: "%b %-d, %Y" }}</time>{% if page.author %} • <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">{{ page.author }}</span></span>{% endif %}</p> | ||
</header> | ||
|
||
<div class="post-content" itemprop="articleBody"> | ||
{{ content }} | ||
</div> | ||
|
||
</article> |
Oops, something went wrong.