Skip to content

Commit 0758798

Browse files
iluetkebiluetkeb
committed
Merge remote-tracking branch 'doc/gh-pages' into feature/doc_theme
2 parents f3173e0 + 46fd99a commit 0758798

158 files changed

Lines changed: 33526 additions & 0 deletions

File tree

Some content is hidden

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

‎.editorconfig‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# https://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
indent_size = 2
8+
indent_style = space
9+
insert_final_newline = true
10+
max_line_length = 80
11+
trim_trailing_whitespace = true
12+
13+
[*.md]
14+
max_line_length = 0
15+
trim_trailing_whitespace = false
16+
17+
[COMMIT_EDITMSG]
18+
max_line_length = 0

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
_site
22
.sass-cache
33
.jekyll-metadata
4+
*.gem
5+
.bundle
6+
vendor/bundle

‎404.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: default
3+
---
4+
5+
<div class="container text-center">
6+
<p>The page you are looking for cannot be found.</p>
7+
<h2>404</h2>
8+
</div>

‎Dockerfile‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
ARG JEKYLL_BASEURL=''
2+
3+
####################################
4+
5+
FROM alpine:3.7 as builder
6+
7+
ENV LANGUAGE en_US.UTF-8
8+
ENV LANG en_US.UTF-8
9+
ENV LC_ALL en_US.UTF-8
10+
11+
ENV BUILD_PACKAGES \
12+
ruby \
13+
ruby-dev \
14+
ruby-rdoc \
15+
ruby-irb \
16+
gcc \
17+
make \
18+
libc-dev \
19+
libffi-dev \
20+
build-base
21+
22+
RUN apk add --no-cache $BUILD_PACKAGES \
23+
&& gem install bundle
24+
25+
WORKDIR /jekyll
26+
ADD . /jekyll
27+
RUN bundle install
28+
29+
ARG JEKYLL_BASEURL
30+
RUN jekyll build --baseurl $JEKYLL_BASEURL
31+
32+
####################################
33+
34+
FROM nginx:alpine
35+
36+
ARG JEKYLL_BASEURL
37+
COPY --from=builder /jekyll/_site /usr/share/nginx/html/$JEKYLL_BASEURL
38+
COPY nginx.conf /etc/nginx/nginx.conf
39+
40+
EXPOSE 80

‎Gemfile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
source "https://rubygems.org"
2+
ruby RUBY_VERSION
3+
4+
gem "jekyll", "3.8.4"
5+
6+
# to use GitHub Pages
7+
# gem "github-pages", group: :jekyll_plugins
8+
9+
# If you have any plugins, put them here!
10+
group :jekyll_plugins do
11+
gem "jekyll-feed"
12+
gem "jekyll-sitemap"
13+
gem "jekyll-redirect-from"
14+
gem "jekyll-seo-tag"
15+
end
16+
17+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
18+
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

‎Gemfile.lock‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.5.2)
5+
public_suffix (>= 2.0.2, < 4.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.0.5)
8+
em-websocket (0.5.1)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0.6.0)
11+
eventmachine (1.2.7)
12+
ffi (1.9.25)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.6.0)
15+
i18n (0.9.5)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (3.8.4)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (~> 0.7)
22+
jekyll-sass-converter (~> 1.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 1.14)
25+
liquid (~> 4.0)
26+
mercenary (~> 0.3.3)
27+
pathutil (~> 0.9)
28+
rouge (>= 1.7, < 4)
29+
safe_yaml (~> 1.0)
30+
jekyll-feed (0.11.0)
31+
jekyll (~> 3.3)
32+
jekyll-redirect-from (0.14.0)
33+
jekyll (~> 3.3)
34+
jekyll-sass-converter (1.5.2)
35+
sass (~> 3.4)
36+
jekyll-seo-tag (2.5.0)
37+
jekyll (~> 3.3)
38+
jekyll-sitemap (1.2.0)
39+
jekyll (~> 3.3)
40+
jekyll-watch (2.1.1)
41+
listen (~> 3.0)
42+
kramdown (1.17.0)
43+
liquid (4.0.1)
44+
listen (3.1.5)
45+
rb-fsevent (~> 0.9, >= 0.9.4)
46+
rb-inotify (~> 0.9, >= 0.9.7)
47+
ruby_dep (~> 1.2)
48+
mercenary (0.3.6)
49+
pathutil (0.16.1)
50+
forwardable-extended (~> 2.6)
51+
public_suffix (3.0.3)
52+
rb-fsevent (0.10.3)
53+
rb-inotify (0.9.10)
54+
ffi (>= 0.5.0, < 2)
55+
rouge (3.3.0)
56+
ruby_dep (1.5.0)
57+
safe_yaml (1.0.4)
58+
sass (3.6.0)
59+
sass-listen (~> 4.0.0)
60+
sass-listen (4.0.0)
61+
rb-fsevent (~> 0.9, >= 0.9.4)
62+
rb-inotify (~> 0.9, >= 0.9.7)
63+
64+
PLATFORMS
65+
ruby
66+
67+
DEPENDENCIES
68+
jekyll (= 3.8.4)
69+
jekyll-feed
70+
jekyll-redirect-from
71+
jekyll-seo-tag
72+
jekyll-sitemap
73+
tzinfo-data
74+
75+
RUBY VERSION
76+
ruby 2.3.7p456
77+
78+
BUNDLED WITH
79+
1.16.2

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Can Güney Aksakalli
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Jekyll Doc Theme
2+
3+
Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.
4+
5+
## Running locally
6+
7+
You need Ruby and gem before starting, then:
8+
9+
```bash
10+
# install bundler
11+
gem install bundler
12+
13+
# clone the project
14+
git clone https://github.com/aksakalli/jekyll-doc-theme.git
15+
cd jekyll-doc-theme
16+
17+
# run jekyll with dependencies
18+
bundle exec jekyll serve
19+
```
20+
21+
## Docker
22+
23+
Alternatively, you can deploy it using the multi-stage [Dockerfile](Dockerfile)
24+
that serves files from Nginx for better performance in production.
25+
26+
Build the image for your site's `JEKYLL_BASEURL`:
27+
28+
```
29+
docker build --build-arg JEKYLL_BASEURL="/" -t jekyll-doc-theme .
30+
```
31+
32+
and serve it:
33+
34+
```
35+
docker run -p 8080:80 jekyll-doc-theme
36+
```
37+
38+
## License
39+
40+
Released under [the MIT license](LICENSE).

‎_config.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Site settings
2+
title: Jekyll Doc Theme
3+
email: your-email@domain.com
4+
description: >
5+
Jekyll Template for Project Websites
6+
providing documentation and blog post pages.
7+
lang: en-US
8+
9+
baseurl: "/jekyll-doc-theme" # the subpath of your site, e.g. /blog/
10+
url: https://aksakalli.github.io/jekyll-doc-theme # the base hostname & protocol for your site
11+
git_address: https://github.com/aksakalli/jekyll-doc-theme
12+
git_edit_address: https://github.com/aksakalli/jekyll-doc-theme/blob/gh-pages
13+
14+
# theme options from https://bootswatch.com/
15+
# comment out this to use default Bootstrap
16+
bootwatch: paper
17+
18+
# Build settings
19+
markdown: kramdown
20+
highlighter: rouge
21+
gems:
22+
- jekyll-feed
23+
- jekyll-redirect-from
24+
- jekyll-seo-tag
25+
- jekyll-sitemap
26+
27+
exclude:
28+
- Gemfile
29+
- Gemfile.lock
30+
- .idea/
31+
- .gitignore
32+
- README.md
33+
timezone: Europe/Berlin
34+
defaults:
35+
- scope:
36+
path: _posts
37+
type: posts
38+
values:
39+
layout: post
40+
sectionid: blog
41+
42+
- scope:
43+
path: _docs
44+
type: docs
45+
values:
46+
layout: docs
47+
sectionid: docs
48+
seo:
49+
type: "WebPage"
50+
51+
collections:
52+
docs:
53+
permalink: /:collection/:path/
54+
output: true
55+
posts:
56+
permalink: /blog/:year/:month/:day/:title/
57+
output: true

‎_data/docs.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- title: Getting Started
2+
docs:
3+
- home
4+
- themes
5+
- customization
6+
7+
- title: Examples
8+
docs:
9+
- cheatsheet
10+
- font-awesome
11+
- bootstrap

0 commit comments

Comments
 (0)