feat(documentation): website documentation (#17)

* feat(documentation): website documentation

.github/workflows/gh-page.yml

@@ -0,0 +1,21 @@
+name: GH-Page
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  refresh:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger GitHub pages rebuild
+        run: |
+          echo "Repository: $REPOSITORY"
+          curl --fail --request POST \
+            --url https://api.github.com/repos/${{ github.repository }}/pages/builds \
+            -u $GH_USER:$GH_TOKEN
+        env:
+          REPOSITORY: ${{ github.repository }}
+          GH_USER: Ealenn
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/jekyll.yml

@@ -0,0 +1,18 @@
+name: Jekyll
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  jekyll:
+    name: Linux
+    runs-on: ubuntu-latest
+    env:
+      jekyll-folder: './docs'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build
+        uses: ealenn/jekyll-build-action@v1
+        with:
+          path: ${{ env.jekyll-folder }}

README.md

@@ -8,21 +8,21 @@
 
 Completely customizable Twitch Bot. 
 
+![](./docs/assets/images/larbinbot.png)
+
 ## Version
 
 The versioning scheme we use is [SemVer](http://semver.org/).
 
 ``` yml
-- lastest: Master Build
+- latest: Master Build
 - x.x.x: Release version x.x.x
 - snapshot: Pull Request / Internal Tests
 ```
 
 ## Getting Started
 
-> You can use [https://twitchapps.com/tmi/](https://twitchapps.com/tmi/) to generate bot password.
-
-### Struture
+### Structure
 
 ```bash
 /my-bot-folder
@@ -49,6 +49,8 @@ services:
       - ${PWD}/config:/tmp
 ```
 
+> You can use [https://twitchapps.com/tmi/](https://twitchapps.com/tmi/) to generate bot password.
+
 Larbin Configuration File :
 ```yml
 # .../my-bot-folder/config/larbin.yml

docs/.gitignore

@@ -0,0 +1,38 @@
+### Jekyll ###
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

docs/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'github-pages', group: :jekyll_plugins
+gem 'jekyll-github-metadata'
+gem 'beautiful-jekyll-theme', '5.0.0'
+gem 'jekyll-toc'