Initial Jekyll Doc Theme commit

.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[COMMIT_EDITMSG]
+max_line_length = 0

.gitignore

@@ -1,4 +1,6 @@
-_site/
-.sass-cache/
-.jekyll-cache/
+_site
+.sass-cache
 .jekyll-metadata
+*.gem
+.bundle
+vendor/bundle

404.html

@@ -0,0 +1,8 @@
+---
+layout: default
+---
+
+<div class="container text-center">
+    <p>The page you are looking for cannot be found.</p>
+    <h2>404</h2>
+</div>

Dockerfile

@@ -0,0 +1,40 @@
+ARG JEKYLL_BASEURL=''
+
+####################################
+
+FROM alpine:3.7 as builder
+
+ENV LANGUAGE en_US.UTF-8
+ENV LANG en_US.UTF-8
+ENV LC_ALL en_US.UTF-8
+
+ENV BUILD_PACKAGES \
+    ruby \
+    ruby-dev \
+    ruby-rdoc \
+    ruby-irb \
+    gcc \
+    make \
+    libc-dev \
+    libffi-dev \
+    build-base
+
+RUN apk add --no-cache $BUILD_PACKAGES \
+    && gem install bundle
+
+WORKDIR /jekyll
+ADD . /jekyll
+RUN bundle install
+
+ARG JEKYLL_BASEURL
+RUN jekyll build --baseurl $JEKYLL_BASEURL
+
+####################################
+
+FROM nginx:alpine
+
+ARG JEKYLL_BASEURL
+COPY --from=builder /jekyll/_site /usr/share/nginx/html/$JEKYLL_BASEURL
+COPY nginx.conf /etc/nginx/nginx.conf
+
+EXPOSE 80

Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+gem "jekyll", "3.8.4"
+
+# to use GitHub Pages
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+   gem "jekyll-feed"
+   gem "jekyll-sitemap"
+   gem "jekyll-redirect-from"
+   gem "jekyll-seo-tag"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

Gemfile.lock

@@ -0,0 +1,79 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.0.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.9.25)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.4)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-feed (0.11.0)
+      jekyll (~> 3.3)
+    jekyll-redirect-from (0.14.0)
+      jekyll (~> 3.3)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.5.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.2.0)
+      jekyll (~> 3.3)
+    jekyll-watch (2.1.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    pathutil (0.16.1)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (3.3.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sass (3.6.0)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (= 3.8.4)
+  jekyll-feed
+  jekyll-redirect-from
+  jekyll-seo-tag
+  jekyll-sitemap
+  tzinfo-data
+
+RUBY VERSION
+   ruby 2.3.7p456
+
+BUNDLED WITH
+   1.16.2

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 visualengineers
+Copyright (c) 2017 Can Güney Aksakalli
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,40 @@
-# glyphboard.github.io
-Documentation for Glyphboard project
+# Jekyll Doc Theme
+
+Go to [the website](https://aksakalli.github.io/jekyll-doc-theme/) for detailed information and demo.
+
+## Running locally
+
+You need Ruby and gem before starting, then:
+
+```bash
+# install bundler
+gem install bundler
+
+# clone the project
+git clone https://github.com/aksakalli/jekyll-doc-theme.git
+cd jekyll-doc-theme
+
+# run jekyll with dependencies
+bundle exec jekyll serve
+```
+
+## Docker
+
+Alternatively, you can deploy it using the multi-stage [Dockerfile](Dockerfile)
+that serves files from Nginx for better performance in production.
+
+Build the image for your site's `JEKYLL_BASEURL`:
+
+```
+docker build --build-arg JEKYLL_BASEURL="/" -t jekyll-doc-theme .
+```
+
+and serve it:
+
+```
+docker run -p 8080:80 jekyll-doc-theme
+```
+
+## License
+
+Released under [the MIT license](LICENSE).

_config.yml

@@ -0,0 +1,57 @@
+# Site settings
+title: Jekyll Doc Theme
+email: [email protected]
+description: >
+  Jekyll Template for Project Websites
+  providing documentation and blog post pages.
+lang: en-US
+
+baseurl: "/jekyll-doc-theme" # the subpath of your site, e.g. /blog/
+url: https://aksakalli.github.io/jekyll-doc-theme # the base hostname & protocol for your site
+git_address: https://github.com/aksakalli/jekyll-doc-theme
+git_edit_address: https://github.com/aksakalli/jekyll-doc-theme/blob/gh-pages
+
+# theme options from https://bootswatch.com/
+# comment out this to use default Bootstrap
+bootwatch: paper
+
+# Build settings
+markdown: kramdown
+highlighter: rouge
+gems:
+  - jekyll-feed
+  - jekyll-redirect-from
+  - jekyll-seo-tag
+  - jekyll-sitemap
+
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - .idea/
+  - .gitignore
+  - README.md
+timezone: Europe/Berlin
+defaults:
+- scope:
+    path: _posts
+    type: posts
+  values:
+    layout: post
+    sectionid: blog
+
+- scope:
+    path: _docs
+    type: docs
+  values:
+    layout: docs
+    sectionid: docs
+    seo:
+      type: "WebPage"
+
+collections:
+  docs:
+    permalink: /:collection/:path/
+    output: true
+  posts:
+    permalink: /blog/:year/:month/:day/:title/
+    output: true

_data/docs.yml

@@ -0,0 +1,11 @@
+- title: Getting Started
+  docs:
+  - home
+  - themes
+  - customization
+
+- title: Examples
+  docs:
+  - cheatsheet
+  - font-awesome
+  - bootstrap

_docs/customization.md

@@ -0,0 +1,13 @@
+---
+title: Customization
+permalink: /docs/customization/
+---
+
+This template uses [bootstrap-sass](https://github.com/twbs/bootstrap-sass) along with [bootwatch themes](https://bootswatch.com/).
+You can create your own theme by writing your own `sass` files.
+
+Create a new a theme folder like `_sass/bootwatch/custom` and set your `bootwatch` variables in `_config.yml` to `custom`:
+
+```yaml
+bootwatch: custom
+```