Skip to content

Commit 8f19bb0

Browse files
author
Christopher Lorenz
committed
Initialise the new preCICE website based on documentation-theme-jekyll
 - based on tomjoht/documentation-theme-jekyll - removes unnecessary files and features of the theme - adds preCICE colour theme in theme-precice.css - adds topnav structure (topnav.yml) - adds sidebars for each navigation item in the topnav - creates a rough skeleton for the docs_sidebar - migrates first pages of the 'configuration' section in the documentation - experiments with features of the new theme: summary section, alerts - adds CC license in the footer
0 parents  commit 8f19bb0

File tree

136 files changed

+19400
-0
lines changed

Some content is hidden

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

136 files changed

+19400
-0
lines changed

Diff for: ‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-metadata
4+
_pdf
5+
.DS_Store
6+
.idea
7+
vendor/
8+
.bundle/

Diff for: ‎.vscode/settings.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Place your settings in this file to overwrite default and user settings.
2+
{
3+
"files.associations": {
4+
"*.html": "liquid"
5+
}
6+
}

Diff for: ‎404.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Page Not Found"
3+
search: exclude
4+
hide_sidebar: true
5+
---
6+
7+
Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

Diff for: ‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
www.precice.org

Diff for: ‎Gemfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source "https://rubygems.org"
2+
3+
# to publish on github page
4+
gem 'github-pages', group: :jekyll_plugins
5+
6+
# to publich without github page
7+
#gem "jekyll"

Diff for: ‎Gemfile.lock

+264
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (6.0.3.2)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
zeitwerk (~> 2.2, >= 2.2.2)
10+
addressable (2.7.0)
11+
public_suffix (>= 2.0.2, < 5.0)
12+
coffee-script (2.4.1)
13+
coffee-script-source
14+
execjs
15+
coffee-script-source (1.11.1)
16+
colorator (1.1.0)
17+
commonmarker (0.17.13)
18+
ruby-enum (~> 0.5)
19+
concurrent-ruby (1.1.7)
20+
dnsruby (1.61.4)
21+
simpleidn (~> 0.1)
22+
em-websocket (0.5.1)
23+
eventmachine (>= 0.12.9)
24+
http_parser.rb (~> 0.6.0)
25+
ethon (0.12.0)
26+
ffi (>= 1.3.0)
27+
eventmachine (1.2.7)
28+
eventmachine (1.2.7-x64-mingw32)
29+
execjs (2.7.0)
30+
faraday (1.0.1)
31+
multipart-post (>= 1.2, < 3)
32+
ffi (1.13.1)
33+
ffi (1.13.1-x64-mingw32)
34+
forwardable-extended (2.6.0)
35+
gemoji (3.0.1)
36+
github-pages (207)
37+
github-pages-health-check (= 1.16.1)
38+
jekyll (= 3.9.0)
39+
jekyll-avatar (= 0.7.0)
40+
jekyll-coffeescript (= 1.1.1)
41+
jekyll-commonmark-ghpages (= 0.1.6)
42+
jekyll-default-layout (= 0.1.4)
43+
jekyll-feed (= 0.13.0)
44+
jekyll-gist (= 1.5.0)
45+
jekyll-github-metadata (= 2.13.0)
46+
jekyll-mentions (= 1.5.1)
47+
jekyll-optional-front-matter (= 0.3.2)
48+
jekyll-paginate (= 1.1.0)
49+
jekyll-readme-index (= 0.3.0)
50+
jekyll-redirect-from (= 0.15.0)
51+
jekyll-relative-links (= 0.6.1)
52+
jekyll-remote-theme (= 0.4.1)
53+
jekyll-sass-converter (= 1.5.2)
54+
jekyll-seo-tag (= 2.6.1)
55+
jekyll-sitemap (= 1.4.0)
56+
jekyll-swiss (= 1.0.0)
57+
jekyll-theme-architect (= 0.1.1)
58+
jekyll-theme-cayman (= 0.1.1)
59+
jekyll-theme-dinky (= 0.1.1)
60+
jekyll-theme-hacker (= 0.1.1)
61+
jekyll-theme-leap-day (= 0.1.1)
62+
jekyll-theme-merlot (= 0.1.1)
63+
jekyll-theme-midnight (= 0.1.1)
64+
jekyll-theme-minimal (= 0.1.1)
65+
jekyll-theme-modernist (= 0.1.1)
66+
jekyll-theme-primer (= 0.5.4)
67+
jekyll-theme-slate (= 0.1.1)
68+
jekyll-theme-tactile (= 0.1.1)
69+
jekyll-theme-time-machine (= 0.1.1)
70+
jekyll-titles-from-headings (= 0.5.3)
71+
jemoji (= 0.11.1)
72+
kramdown (= 2.3.0)
73+
kramdown-parser-gfm (= 1.1.0)
74+
liquid (= 4.0.3)
75+
mercenary (~> 0.3)
76+
minima (= 2.5.1)
77+
nokogiri (>= 1.10.4, < 2.0)
78+
rouge (= 3.19.0)
79+
terminal-table (~> 1.4)
80+
github-pages-health-check (1.16.1)
81+
addressable (~> 2.3)
82+
dnsruby (~> 1.60)
83+
octokit (~> 4.0)
84+
public_suffix (~> 3.0)
85+
typhoeus (~> 1.3)
86+
html-pipeline (2.13.0)
87+
activesupport (>= 2)
88+
nokogiri (>= 1.4)
89+
http_parser.rb (0.6.0)
90+
i18n (0.9.5)
91+
concurrent-ruby (~> 1.0)
92+
jekyll (3.9.0)
93+
addressable (~> 2.4)
94+
colorator (~> 1.0)
95+
em-websocket (~> 0.5)
96+
i18n (~> 0.7)
97+
jekyll-sass-converter (~> 1.0)
98+
jekyll-watch (~> 2.0)
99+
kramdown (>= 1.17, < 3)
100+
liquid (~> 4.0)
101+
mercenary (~> 0.3.3)
102+
pathutil (~> 0.9)
103+
rouge (>= 1.7, < 4)
104+
safe_yaml (~> 1.0)
105+
jekyll-avatar (0.7.0)
106+
jekyll (>= 3.0, < 5.0)
107+
jekyll-coffeescript (1.1.1)
108+
coffee-script (~> 2.2)
109+
coffee-script-source (~> 1.11.1)
110+
jekyll-commonmark (1.3.1)
111+
commonmarker (~> 0.14)
112+
jekyll (>= 3.7, < 5.0)
113+
jekyll-commonmark-ghpages (0.1.6)
114+
commonmarker (~> 0.17.6)
115+
jekyll-commonmark (~> 1.2)
116+
rouge (>= 2.0, < 4.0)
117+
jekyll-default-layout (0.1.4)
118+
jekyll (~> 3.0)
119+
jekyll-feed (0.13.0)
120+
jekyll (>= 3.7, < 5.0)
121+
jekyll-gist (1.5.0)
122+
octokit (~> 4.2)
123+
jekyll-github-metadata (2.13.0)
124+
jekyll (>= 3.4, < 5.0)
125+
octokit (~> 4.0, != 4.4.0)
126+
jekyll-mentions (1.5.1)
127+
html-pipeline (~> 2.3)
128+
jekyll (>= 3.7, < 5.0)
129+
jekyll-optional-front-matter (0.3.2)
130+
jekyll (>= 3.0, < 5.0)
131+
jekyll-paginate (1.1.0)
132+
jekyll-readme-index (0.3.0)
133+
jekyll (>= 3.0, < 5.0)
134+
jekyll-redirect-from (0.15.0)
135+
jekyll (>= 3.3, < 5.0)
136+
jekyll-relative-links (0.6.1)
137+
jekyll (>= 3.3, < 5.0)
138+
jekyll-remote-theme (0.4.1)
139+
addressable (~> 2.0)
140+
jekyll (>= 3.5, < 5.0)
141+
rubyzip (>= 1.3.0)
142+
jekyll-sass-converter (1.5.2)
143+
sass (~> 3.4)
144+
jekyll-seo-tag (2.6.1)
145+
jekyll (>= 3.3, < 5.0)
146+
jekyll-sitemap (1.4.0)
147+
jekyll (>= 3.7, < 5.0)
148+
jekyll-swiss (1.0.0)
149+
jekyll-theme-architect (0.1.1)
150+
jekyll (~> 3.5)
151+
jekyll-seo-tag (~> 2.0)
152+
jekyll-theme-cayman (0.1.1)
153+
jekyll (~> 3.5)
154+
jekyll-seo-tag (~> 2.0)
155+
jekyll-theme-dinky (0.1.1)
156+
jekyll (~> 3.5)
157+
jekyll-seo-tag (~> 2.0)
158+
jekyll-theme-hacker (0.1.1)
159+
jekyll (~> 3.5)
160+
jekyll-seo-tag (~> 2.0)
161+
jekyll-theme-leap-day (0.1.1)
162+
jekyll (~> 3.5)
163+
jekyll-seo-tag (~> 2.0)
164+
jekyll-theme-merlot (0.1.1)
165+
jekyll (~> 3.5)
166+
jekyll-seo-tag (~> 2.0)
167+
jekyll-theme-midnight (0.1.1)
168+
jekyll (~> 3.5)
169+
jekyll-seo-tag (~> 2.0)
170+
jekyll-theme-minimal (0.1.1)
171+
jekyll (~> 3.5)
172+
jekyll-seo-tag (~> 2.0)
173+
jekyll-theme-modernist (0.1.1)
174+
jekyll (~> 3.5)
175+
jekyll-seo-tag (~> 2.0)
176+
jekyll-theme-primer (0.5.4)
177+
jekyll (> 3.5, < 5.0)
178+
jekyll-github-metadata (~> 2.9)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-slate (0.1.1)
181+
jekyll (~> 3.5)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-tactile (0.1.1)
184+
jekyll (~> 3.5)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-time-machine (0.1.1)
187+
jekyll (~> 3.5)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-titles-from-headings (0.5.3)
190+
jekyll (>= 3.3, < 5.0)
191+
jekyll-watch (2.2.1)
192+
listen (~> 3.0)
193+
jemoji (0.11.1)
194+
gemoji (~> 3.0)
195+
html-pipeline (~> 2.2)
196+
jekyll (>= 3.0, < 5.0)
197+
kramdown (2.3.0)
198+
rexml
199+
kramdown-parser-gfm (1.1.0)
200+
kramdown (~> 2.0)
201+
liquid (4.0.3)
202+
listen (3.2.1)
203+
rb-fsevent (~> 0.10, >= 0.10.3)
204+
rb-inotify (~> 0.9, >= 0.9.10)
205+
mercenary (0.3.6)
206+
mini_portile2 (2.4.0)
207+
minima (2.5.1)
208+
jekyll (>= 3.5, < 5.0)
209+
jekyll-feed (~> 0.9)
210+
jekyll-seo-tag (~> 2.1)
211+
minitest (5.14.1)
212+
multipart-post (2.1.1)
213+
nokogiri (1.10.10)
214+
mini_portile2 (~> 2.4.0)
215+
nokogiri (1.10.10-x64-mingw32)
216+
mini_portile2 (~> 2.4.0)
217+
octokit (4.18.0)
218+
faraday (>= 0.9)
219+
sawyer (~> 0.8.0, >= 0.5.3)
220+
pathutil (0.16.2)
221+
forwardable-extended (~> 2.6)
222+
public_suffix (3.1.1)
223+
rb-fsevent (0.10.4)
224+
rb-inotify (0.10.1)
225+
ffi (~> 1.0)
226+
rexml (3.2.4)
227+
rouge (3.19.0)
228+
ruby-enum (0.8.0)
229+
i18n
230+
rubyzip (2.3.0)
231+
safe_yaml (1.0.5)
232+
sass (3.7.4)
233+
sass-listen (~> 4.0.0)
234+
sass-listen (4.0.0)
235+
rb-fsevent (~> 0.9, >= 0.9.4)
236+
rb-inotify (~> 0.9, >= 0.9.7)
237+
sawyer (0.8.2)
238+
addressable (>= 2.3.5)
239+
faraday (> 0.8, < 2.0)
240+
simpleidn (0.1.1)
241+
unf (~> 0.1.4)
242+
terminal-table (1.8.0)
243+
unicode-display_width (~> 1.1, >= 1.1.1)
244+
thread_safe (0.3.6)
245+
typhoeus (1.4.0)
246+
ethon (>= 0.9.0)
247+
tzinfo (1.2.7)
248+
thread_safe (~> 0.1)
249+
unf (0.1.4)
250+
unf_ext
251+
unf_ext (0.0.7.7)
252+
unf_ext (0.0.7.7-x64-mingw32)
253+
unicode-display_width (1.7.0)
254+
zeitwerk (2.4.0)
255+
256+
PLATFORMS
257+
ruby
258+
x64-mingw32
259+
260+
DEPENDENCIES
261+
github-pages
262+
263+
BUNDLED WITH
264+
2.1.4

Diff for: ‎README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
preCICE Webpage https://www.precice.org/
2+
3+
## Local development
4+
The website is using [Jekyll](https://jekyllrb.com/) static website generator and [Github pages](https://pages.github.com/).
5+
To run and develop it locally you would need [Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/).
6+
With Ruby, you can install bundler using `gem install bundler`.
7+
8+
After that all you need is:
9+
10+
```
11+
git clone https://github.com/precice/precice.github.io && cd precice.github.io
12+
bundle install
13+
bundle exec jekyll serve --safe
14+
```
15+
You can now view website locally in your browser at http://localhost:4000
16+
17+
## SASS
18+
19+
We use SCSS in our project, __NOT__ the semicolon and braceless style that is SASS.
20+
21+
We use the front-end framework foundation 6.5.1.
22+
The sass files are located in `_sass`, the main settings file is `_settings.scss`.
23+
Due to the restrictions of jekyll's strict mode we are not allowed to specify multiple search paths.
24+
25+
Thus, the sass-roots of foundation and its dependecies are merged in the folder `foundation`.
26+
Please leave this directory untouched as it greatly simplifies updating the foundation framework.
27+
28+
The folder `precice` contains project specific files, these are all imported by `_precice.scss` at the root.
29+
Use this folder to add new css.
30+
31+
`css/main.scss` is the main css file that will be compiled and compressed into the final css file.

0 commit comments

Comments
 (0)