Implement docs for github.io

tsuwatch · Dec 15, 2017 · 574014e · 574014e
1 parent e75cbb1
commit 574014e
Show file tree

Hide file tree

Showing 17 changed files with 310 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 app
 packages
 *.zip
+docs/vendor
diff --git a/README.md b/README.md
@@ -7,8 +7,8 @@
 
 アラートによる放送通知や、自分のフォロー中放送などさまざまな方法で放送を探すことができます。
 
-![](/screenshots/preview.png)
-![](/screenshots/preview2.png)
+![](/images/preview.png)
+![](/images/preview2.png)
 
 ## ダウンロード
 - Mac

diff --git a/_config.yml b/_config.yml
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+_site
+.sass-cache
+.jekyll-metadata
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 3.6.2"
+gem "jekyll-theme-cayman"
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -0,0 +1,59 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    jekyll (3.6.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 3)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.5.1)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.4.0)
+      jekyll (~> 3.3)
+    jekyll-theme-cayman (0.1.0)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-watch (1.5.1)
+      listen (~> 3.0)
+    kramdown (1.16.2)
+    liquid (4.0.0)
+    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.0)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.1)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sass (3.5.3)
+      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.6.2)
+  jekyll-theme-cayman
+
+BUNDLED WITH
+   1.16.0
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,40 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: ニコニコ生放送デスクトップアプリ
+description:
+  コメントビューアによるコメント表示や放送開始の通知を受け取ることができます
+twitter_username: tsuwatch
+github_username:  tsuwatch
+show_downloads: true
+github:
+  is_project_page: true
+  repository_name: kaizoku
+  repository_url: https://github.com/tsuwatch/kaizoku
+  zip_url: https://github.com/tsuwatch/kaizoku/releases/download/v0.5.0/nicomentron-darwin-x64.zip
+  owner_name: tsuwatch
+  owner_url: https://github.com/tsuwatch
+
+# Build settings
+markdown: kramdown
+theme: jekyll-theme-cayman
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - vendor
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+
+{% seo %}
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+    <link rel="stylesheet" href="{{ '/assets/css/custom.css?v=' | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <section class="page-header">
+      <h1 class="project-name">
+        <img src="/assets/images/logo.png" class="logo" />
+      </h1>
+      <h2 class="project-tagline">{{ site.title }}</h2>
+      <h2 class="project-tagline">{{ site.description | default: site.github.project_tagline }}</h2>
+      <!--
+      {% if site.github.is_project_page %}
+        <a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
+      {% endif %}
+      -->
+      {% if site.show_downloads %}
+        <a href="{{ site.github.zip_url }}" class="btn">ダウンロード（Mac）</a>
+        <!--<a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>-->
+      {% endif %}
+
+      <div><img src="/assets/images/preview.png" class="banner-image" /></div>
+    </section>
+
+    <section class="main-content">
+      {{ content }}
+
+      {% if site.show_downloads %}
+        <div class="container">
+          <a href="{{ site.github.zip_url }}" class="btn">ダウンロード（Mac）</a>
+        </div>
+        <!--<a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>-->
+      {% endif %}
+
+      <footer class="site-footer">
+        {% if site.github.is_project_page %}
+          <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+        {% endif %}
+        <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
+      </footer>
+    </section>
+
+    {% if site.google_analytics %}
+      <script type="text/javascript">
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+        ga('create', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+      </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css
@@ -0,0 +1,73 @@
+.btn {
+  background-color: rgba(255, 163, 80, 1);
+  border-color: rgba(255, 163, 80, 1);
+  color: rgba(255, 255, 255, 1);
+}
+
+.btn:hover {
+  background-color: rgba(255, 163, 80, .8);
+  border-color: rgba(255, 163, 80, .8);
+}
+
+.project-name {
+  display: inline-block;
+}
+
+.logo {
+  width: 50%;
+}
+
+.banner-image {
+  width: 65%;
+  display: inline-block;
+  margin-bottom: -16rem;
+  box-shadow: 0 0 2rem rgba(0, 0, 0, .2);
+  margin-top: 50px;
+}
+
+.wrapper {
+  margin-top: 10rem;
+}
+
+.container {
+  text-align: center;
+}
+
+.wrapper div:last-child {
+  border: none;
+}
+
+.content-container {
+  display: flex;
+  display: -webkit-flex;
+  justify-content: space-between;
+  -webkit-justify-content: space-between;
+  align-items: center;
+  -webkit-align-items: center;
+  padding: 70px 0;
+  border-bottom: 1px solid #eff0f1
+}
+
+.media-container {
+  width: 50%;
+}
+
+.media-container img {
+  box-shadow: 0 0 2rem rgba(0, 0, 0, .2);
+}
+
+.right {
+  margin-left: 40px;
+}
+
+.left {
+  margin-right: 40px;
+}
+
+.info-container {
+  width: 50%;
+}
+
+.info-container h2 {
+  color: #ffa350;
+}
diff --git a/docs/assets/images/alert.png b/docs/assets/images/alert.png
diff --git a/docs/assets/images/back.png b/docs/assets/images/back.png
diff --git a/docs/assets/images/comment.png b/docs/assets/images/comment.png
diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png
diff --git a/docs/assets/images/preview.png b/docs/assets/images/preview.png
diff --git a/docs/assets/images/voyage.png b/docs/assets/images/voyage.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,41 @@
+---
+layout: default
+---
+<div></div>
+<div class="wrapper">
+  <div class="content-container">
+    <div class="info-container">
+      <h2>コメントビューア</h2>
+      <p>（可能な限り）全部屋のコメントを表示することができます。</p>
+    </div>
+    <div class="media-container right">
+      <img src="/assets/images/comment.png" />
+    </div>
+  </div>
+  <div class="content-container">
+    <div class="media-container left">
+      <img src="/assets/images/alert.png" />
+    </div>
+    <div class="info-container">
+      <h2>放送開始通知</h2>
+      <p>フォローしている放送の開始通知を受け取ることができ、通知をクリックすることで、その放送を開くことができます。</p>
+    </div>
+  </div>
+  <div class="content-container">
+    <div class="info-container">
+      <h2>見つける</h2>
+      <p>さまざまな方法で放送を探すことができます</p>
+      <ul>
+        <li>キーワード、タグでの条件検索</li>
+        <li>検索条件のお気に入り</li>
+        <li>フォローしている放送の閲覧</li>
+        <li>ニコニコ生放送各種ランキングの閲覧</li>
+        <li>放送をピン留めして、視聴しながらの検索</li>
+        <li>放送終了を検知して、プレイリストの次の放送へ自動移動</li>
+      </ul>
+    </div>
+    <div class="media-container right">
+      <img src="/assets/images/voyage.png" />
+    </div>
+  </div>
+</div>