Skip to content

Commit a427aa5

Browse files
committed
create docs
1 parent 0aa963b commit a427aa5

24 files changed

+878
-3
lines changed

docs/.gitignore

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

docs/_config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Site settings
2+
port: 4000
3+
title: joonsrenderer gem for JRubyArt and propane
4+
email: mamba2928@yahoo.co.uk
5+
description: > # this means to ignore newlines until "baseurl:"
6+
The joonsrenderer gem is wrapper around the joonsrenderer library by Joon HyubLee that makes it very easy to sunflow raytracing of JRubyArt and propane sketches.
7+
baseurl: "" # the subpath of your site, e.g. /blog
8+
regenerate: true
9+
url: "https://ruby-processing.github.io/joonsrenderer"
10+
11+
urls:
12+
bugs: https://github.com/ruby-processing/joonsrenderer/issues/
13+
github: https://github.com/ruby-processing/joonsrenderer/
14+
twitter_username: monkstoneT
15+
github_username: monkstone
16+
17+
syntax-highlighting:
18+
enabled: true
19+
# Build settings
20+
markdown: kramdown

docs/_includes/footer.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<footer class="site-footer">
2+
3+
<div class="wrapper">
4+
5+
<h2 class="footer-heading">{{ site.title }}</h2>
6+
7+
<div class="footer-col-wrapper">
8+
<div class="footer-col footer-col-1">
9+
<ul class="contact-list">
10+
<li>{{ site.title }}</li>
11+
<li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
12+
</ul>
13+
</div>
14+
15+
<div class="footer-col footer-col-2">
16+
<ul class="social-media-list">
17+
{% if site.github_username %}
18+
<li>
19+
{% include icon-github.html username=site.github_username %}
20+
</li>
21+
{% endif %}
22+
23+
{% if site.twitter_username %}
24+
<li>
25+
{% include icon-twitter.html username=site.twitter_username %}
26+
</li>
27+
{% endif %}
28+
</ul>
29+
</div>
30+
31+
<div class="footer-col footer-col-3">
32+
<p>{{ site.description }}</p>
33+
</div>
34+
</div>
35+
36+
</div>
37+
38+
</footer>

docs/_includes/head.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<head>
2+
<meta charset="utf-8">
3+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
4+
<meta name="viewport" content="width=device-width, initial-scale=1">
5+
{% if page.keywords %}
6+
<meta name="keywords" content="{{ page.keywords }}" />
7+
{% else %}
8+
<meta name="keywords" content="art, JRubyArt, code, blog, ruby" />
9+
{% endif %}<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
10+
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
11+
12+
<link rel="stylesheet" href="https://ruby-processing.github.io/JRubyArt/css/main.css"/>
13+
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.github.url | prepend: site.url }}">
14+
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.github.url | prepend: site.url }}" />
15+
</head>

docs/_includes/header.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<header class="site-header">
2+
3+
<div class="wrapper">
4+
5+
<a class="site-title" href="{{ site.baseurl }}/">{{ site.title }}</a>
6+
7+
<nav class="site-nav">
8+
<a href="#" class="menu-icon">
9+
<svg viewBox="0 0 18 15">
10+
<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"/>
11+
<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"/>
12+
<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"/>
13+
</svg>
14+
</a>
15+
16+
<div class="trigger">
17+
{% for my_page in site.pages %}
18+
{% if my_page.title %}
19+
<a class="page-link" href="{{ my_page.url | prepend: site.github.url }}">{{ my_page.title }}</a>
20+
{% endif %}
21+
{% endfor %}
22+
</div>
23+
</nav>
24+
25+
</div>
26+
27+
</header>

docs/_includes/icon-github.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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>

docs/_includes/icon-github.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_includes/icon-twitter.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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>

docs/_includes/icon-twitter.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_layouts/default.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
{% include head.html %}
5+
6+
<body>
7+
8+
{% include header.html %}
9+
10+
<div class="page-content">
11+
<div class="wrapper">
12+
{{ content }}
13+
</div>
14+
</div>
15+
16+
{% include footer.html %}
17+
18+
</body>
19+
20+
</html>

0 commit comments

Comments
 (0)