Skip to content

Commit 61b9c73

Browse files
author
Benjamin Pick
committed
add docs [ci skip]
1 parent 80034c9 commit 61b9c73

File tree

5 files changed

+108
-2
lines changed

5 files changed

+108
-2
lines changed

‎_config.yml

+33-2
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,22 @@ description: >- # this means to ignore newlines until "baseurl:"
2525
The city & country names are translated in different languages.
2626
baseurl: "/geoip-detect/" # the subpath of your site, e.g. /blog
2727
url: "https://yellowtree.github.io/" # the base hostname & protocol for your site, e.g. http://example.com
28-
twitter_username: jekyllrb
29-
github_username: jekyll
28+
github_username: benjaminpick
3029

3130
# Build settings
3231
theme: minima
3332
plugins:
3433
- jekyll-feed
34+
# - jekyll-paginate
35+
- jekyll-sitemap
36+
# - jekyll-gist
37+
# - jemoji
38+
- jekyll-include-cache
39+
# - jekyll-avatar
40+
# - jekyll-redirect-from
41+
- jekyll-remote-theme
42+
- jekyll-github-metadata
43+
3544

3645
# Exclude from processing.
3746
# The following items will not be processed, by default.
@@ -53,4 +62,26 @@ plugins:
5362
# - vendor/gems/
5463
# - vendor/ruby/
5564

65+
5666
markdown: GFM
67+
68+
remote_theme: mmistakes/[email protected]
69+
70+
defaults:
71+
- scope:
72+
path: "wiki"
73+
type: pages
74+
values:
75+
layout: wiki
76+
77+
footer:
78+
links:
79+
- label: "GitHub"
80+
icon: "fab fa-fw fa-github"
81+
url: "https://github.com/yellowtree/geoip-detect"
82+
- label: "WordPress"
83+
icon: "fab fa-fw fa-wordpress-simple"
84+
url: "http://wordpress.org/plugins/geoip-detect/"
85+
- label: "PayPal"
86+
icon: "fab fa-fw fa-paypal"
87+
url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BSYUZHS8FH3CL"

‎deploy.sh

+1
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ echo "Ignoring github specific files, tests and deployment script"
182182
svn propset svn:ignore "deploy.sh
183183
bin
184184
docs
185+
_config.yml
185186
README.md
186187
CHANGELOG.md
187188
.git

‎docs/_includes/footer.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{% comment %}<!-- overrides: https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/footer.html -->{% endcomment %}
2+
3+
<div class="page__footer-follow">
4+
<ul class="social-icons">
5+
{% if site.data.ui-text[site.locale].follow_label %}
6+
<li><strong>{{ site.data.ui-text[site.locale].follow_label }}</strong></li>
7+
{% endif %}
8+
9+
{% if site.footer.links %}
10+
{% for link in site.footer.links %}
11+
{% if link.label and link.url %}
12+
<li><a href="{{ link.url }}" rel="nofollow noopener noreferrer"><i class="{{ link.icon | default: 'fas fa-link' }}" aria-hidden="true"></i> {{ link.label }}</a></li>
13+
{% endif %}
14+
{% endfor %}
15+
{% endif %}
16+
17+
{% unless site.atom_feed.hide %}
18+
<li><a href="{% if site.atom_feed.path %}{{ site.atom_feed.path }}{% else %}{{ '/feed.xml' | relative_url }}{% endif %}"><i class="fas fa-fw fa-rss-square" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].feed_label | default: "Feed" }}</a></li>
19+
{% endunless %}
20+
</ul>
21+
</div>
22+
23+
<div class="page__footer-copyright">&copy; {{ site.time | date: '%Y' }} {{ site.name | default: site.title }} &#8226; <a href="/legal/">Legal</a> &#8226; <a href="/history/">History</a> &#8226; <a href="/brand/">Branding Guidelines</a>
24+
</div>

‎docs/_includes/wiki_sidebar.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Table of Contents
2+
3+
## API
4+
* [Usage Examples](./API-Usage-Examples)

‎docs/_layouts/wiki.html

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# Based on https://github.com/mmistakes/minimal-mistakes/blob/master/_layouts/single.html
3+
layout: default_wiki
4+
---
5+
6+
<div id="main" role="main">
7+
<header>
8+
{% if page.title %}<h1 id="page-title" class="page__title" itemprop="headline">{{ page.title | markdownify | remove: "<p>" | remove: "</p>" }}</h1>{% endif %}
9+
10+
<div class="header-meta">
11+
{% comment %}{% if page.last_modified_at %}Last edited on {{ page.last_modified_at | date: '%d %B %Y' }} • {% endif %}{% endcomment %}<a href="{{ site.github.repository_url }}/commits/dev/{{ page.path }}">View revision history</a> • <a href="{{ site.github.repository_url }}/edit/dev/{{ page.path }}">Edit on GitHub</a>
12+
</div>
13+
</header>
14+
<article class="page h-entry" itemscope itemtype="https://schema.org/CreativeWork">
15+
<div class="page__inner-wrap">
16+
<section class="page__content e-content markdown-body" itemprop="text">
17+
18+
{{ content }}
19+
20+
<aside class="sidebar__right">
21+
<div class="toc">
22+
<div class="wiki_toc__menu">
23+
<input id="wiki_ac-toc" name="accordion-toc" type="checkbox" />
24+
<label for="wiki_ac-toc">{{ site.data.ui-text[site.locale].menu_label | default: "Toggle Menu" }}</label>
25+
26+
{% capture sidebar_include %}{% include_cached wiki_sidebar.md %}{% endcapture %}
27+
<div class="wiki_nav__items">
28+
{{ sidebar_include | markdownify }}
29+
</div>
30+
</div>
31+
</div>
32+
</aside>
33+
34+
<div class="copyright_footer">
35+
<p style="font-size: 13px;margin-bottom: 0px !important;">
36+
<b>© {{ site.time | date: '%Y' }} libGDX</b> • This wiki is a community effort. If you find information out of date or want to add some more in-depth explanations, you are very welcome to do the necessary changes. Before contributing, please take a look at our <a href="/wiki/misc/wiki-style-guide">Wiki Style Guide</a>.
37+
<br />
38+
<br />
39+
<b>If you need additional help, check out our community on <a href="/community/discord/">Discord</a>!</b>
40+
</p>
41+
</div>
42+
</section>
43+
</div>
44+
45+
</article>
46+
</div>

0 commit comments

Comments
 (0)