Skip to content

Commit 01205be

Browse files
authored
Merge pull request #27 from bird-house/use-minima-theme
using minima theme
2 parents 045129a + 198380f commit 01205be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+831
-586
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.bundle
2+
.sass-cache
3+
Gemfile.lock
4+
_site
5+
*.gem

.travis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
language: ruby
2+
sudo: true
3+
rvm:
4+
- 2.4.3
5+
addons:
6+
apt:
7+
packages:
8+
- libcurl4-openssl-dev
9+
script: bundle exec rake test
10+
env:
11+
global:
12+
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true

Gemfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
source 'https://rubygems.org'
2+
3+
# Minima is a default theme for Jekyll sites.
4+
gem "minima"
5+
6+
group :development do
7+
gem 'jekyll', '~> 3.8.0'
8+
#gem 'jekyll-sitemap'
9+
#gem 'jekyll-last-modified-at'
10+
#gem 'jemoji'
11+
end
12+
13+
group :test do
14+
gem 'rake'
15+
gem 'html-proofer'
16+
end

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

README.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,67 @@
1-
bird-house.github.io
2-
====================
1+
# Birdhouse Website
32

4-
Project pages for Birdhouse http://bird-house.github.io
3+
[![Build Status](https://travis-ci.org/bird-house/bird-house.github.io.svg?branch=master)](https://travis-ci.org/bird-house/bird-house.github.io)
4+
[![GitHub license](https://img.shields.io/github/license/bird-house/bird-house.github.io.svg)](https://github.com/bird-house/bird-house.github.io/blob/master/LICENSE)
5+
6+
This is the source of the [Birdhouse Website](https://bird-house.github.io/).
7+
8+
The Birdhouse Website is the main site for the Birdhouse project
9+
where you can find links to documentation and demos.
10+
11+
## Contributing
12+
13+
Contributions are welcome. Feel free to open a pull request with changes.
14+
15+
### Running it Locally
16+
17+
It can be helpful to preview changes on your computer before opening a pull request. The *Birdhouse Website* uses the [Jekyll static site generator](http://jekyllrb.com/).
18+
19+
Clone this repository locally, and cd into it:
20+
21+
```
22+
$ git clone https://github.com/bird-house/bird-house.github.io
23+
$ cd bird-house.github.io
24+
```
25+
26+
Make sure you have ruby installed on your computer.
27+
See https://www.ruby-lang.org/en/downloads/.
28+
29+
Install `bundler`, and use it to install the dependencies to build the website:
30+
31+
```
32+
gem install bundler
33+
bundle install
34+
```
35+
36+
Now you can ask Jekyll to build the website:
37+
38+
```
39+
bundle exec jekyll build
40+
bundle exec jekyll serve
41+
```
42+
43+
Point your browser at http://localhost:4000.
44+
45+
Edit the various parts, Jekyll should automatically rebuild and
46+
refresh the pages when changes occur.
47+
48+
To stop serving the website, press **`Ctrl`**-`C` in your terminal.
49+
50+
## Deployment
51+
52+
Pull requests merged to the master branch are automatically deployed to the production website.
53+
54+
## Where to Edit?
55+
56+
You can edit the main page of the website by changing `index.md`.
57+
It is written in [Markdown](https://guides.github.com/features/mastering-markdown/).
58+
59+
The site has other pages written in Markdown like `about.md`.
60+
61+
To customise the layout read the documentation of the [minima theme](https://github.com/jekyll/minima).
62+
63+
## Links
64+
65+
* [Jekyll minima theme](https://github.com/jekyll/minima) ([view](https://jekyll.github.io/minima/))
66+
* [Jupyter Website](https://github.com/jupyter/jupyter.github.io) based on minima theme ([view](https://jupyter.org/))
67+
* [Markdown](https://guides.github.com/features/mastering-markdown/)

Rakefile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
require 'html-proofer'
2+
# rake test
3+
desc "build and test website"
4+
task :test do
5+
sh "bundle exec jekyll build"
6+
HTMLProofer.check_directory("./_site", {
7+
:assume_extension => true,
8+
:check_favicon => true,
9+
:external_only => true,
10+
:only_4xx => true,
11+
#:url_swap => { %r{https://www.markdownguide.org} => '' },
12+
:typhoeus => {
13+
:ssl_verifypeer => false,
14+
:ssl_verifyhost => 0},
15+
verbose => true}).run
16+
end

_config.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
title: Birdhouse
2+
logo: /assets/birdhouse-logo.png
3+
author: Copyright © 2018 Project Birdhouse
4+
# email: ehbrecht@dkrz.de
5+
theme: minima
6+
description: >
7+
Climate data analytics for sustainable development using OGC standards.
8+
9+
# social links
10+
github_username: bird-house
11+
gitter_username: bird-house
12+
13+
header_pages:
14+
- about.md
15+
#- documentation.md
16+
- contact.md

_includes/header.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<header class="site-header">
2+
3+
<div class="wrapper">
4+
{%- assign default_paths = site.pages | map: "path" -%}
5+
{%- assign page_paths = site.header_pages | default: default_paths -%}
6+
{%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
7+
<a class="site-title" rel="author" href="{{ "/" | relative_url }}"><img src="{{ site.logo }}" height="32px"> {{ site.title | escape }}</a>
8+
9+
{%- if titles_size > 0 -%}
10+
<nav class="site-nav">
11+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
12+
<label for="nav-trigger">
13+
<span class="menu-icon">
14+
<svg viewBox="0 0 18 15" width="18px" height="15px">
15+
<path 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.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
16+
</svg>
17+
</span>
18+
</label>
19+
20+
<div class="trigger">
21+
{%- for path in page_paths -%}
22+
{%- assign my_page = site.pages | where: "path", path | first -%}
23+
{%- if my_page.title -%}
24+
<a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
25+
{%- endif -%}
26+
{%- endfor -%}
27+
</div>
28+
</nav>
29+
{%- endif -%}
30+
</div>
31+
</header>

0 commit comments

Comments
 (0)