Make docs page

ayato-p · ayato-p · commit cef90f40b1df · 2025-04-17T09:10:03.000+09:00
diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml
@@ -37,5 +37,5 @@ jobs:
     needs: on-success
     steps: 
       - name: Deploy to GitHub Pages
-        uses: actions/deploy-pages@v3
+        uses: actions/deploy-pages@v4
         id: deployment
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,6 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+Gemfile.lock
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1,24 @@
+---
+permalink: /404.html
+---
+
+<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,33 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 4.2.2"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", "~> 232", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,10 @@
+.ONESHELL: prepare
+
+prepare:
+		./prepare.sh
+
+build:
+	     docker run -v .:/srv/jekyll:Z -it jekyll/jekyll:4.2.2 jekyll build
+
+serve: build
+	     docker run -v ./_site:/usr/share/nginx/html:ro -p 8080:80  nginx
diff --git a/docs/_config.yaml b/docs/_config.yaml
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,51 @@
+# 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.
+#
+# If you need help with YAML syntax, here are some quick references for you: 
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# 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: Playtest2 Docs
+description: >- # this means to ignore newlines until "baseurl:"
+  Document for Playtest2
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "https://uzabase.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+github_username: uzabase
+
+# Build settings
+remote_theme: sighingnow/jekyll-gitbook
+plugins:
+  - jekyll-feed
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/
diff --git a/docs/_data/.keep b/docs/_data/.keep
diff --git a/docs/_data/playtest-core.yaml b/docs/_data/playtest-core.yaml
@@ -0,0 +1,16 @@
+steps:
+  - キー<key>に対応する値が
+  - 小数値の<value>である
+  - 整数値の<value>である
+  - 整数値の<value>以上である
+  - 文字列の<value>である
+  - 文字列の<value>を含んでいる
+  - 正規表現の<value>に完全一致している
+  - 真偽値の<value>である
+  - 真である
+  - 偽である
+  - 存在している
+  - 存在していない
+  - nullである
+  - テーブル<table>である
+  - 以下のテーブルである
diff --git a/docs/_data/playtest-http.yaml b/docs/_data/playtest-http.yaml
@@ -0,0 +1,12 @@
+steps:
+  - パス<path>に
+  - JSONボディ<json>を
+  - メディアタイプ<mediaType>で
+  - メソッド<method>で
+  - ヘッダー<header>で
+  - リクエストを送る
+  - JSONのパス<jsonPath>に対応する値が
+  - レスポンスのステータスコードが
+  - レスポンスのボディが
+  - レスポンスのヘッダーが
+  - レスポンスのヘッダーの
diff --git a/docs/_data/playtest-jdbc.yaml b/docs/_data/playtest-jdbc.yaml
@@ -0,0 +1,2 @@
+steps:
+  - DB<databaseName>にSQL<sql>を実行した結果が
diff --git a/docs/_data/playtest-wiremock.yaml b/docs/_data/playtest-wiremock.yaml
@@ -0,0 +1,8 @@
+steps:
+  - API<apiName>についてメソッド<method>でパス<path>に
+  - クエリ<name>が<value>として
+  - ヘッダー<header>として
+  - ヘッダー<name>が<value>として
+  - JSONボディ<json>として
+  - JSONパス<jsonPath>に文字列表現の<value>を持つ
+  - リクエストが送られた回数が
diff --git a/docs/_posts/.keep b/docs/_posts/.keep
diff --git a/docs/about.markdown b/docs/about.markdown
@@ -0,0 +1,17 @@
+---
+title: About
+permalink: /about/
+---
+
+This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
+
+You can find the source code for Minima at GitHub:
+[jekyll][jekyll-organization] /
+[minima](https://github.com/jekyll/minima)
+
+You can find the source code for Jekyll at GitHub:
+[jekyll][jekyll-organization] /
+[jekyll](https://github.com/jekyll/jekyll)
+
+
+[jekyll-organization]: https://github.com/jekyll
diff --git a/docs/docker-compose.yaml b/docs/docker-compose.yaml
diff --git a/docs/index.markdown b/docs/index.markdown
@@ -0,0 +1,29 @@
+---
+layout: home
+title: Playtest2 Docs
+---
+
+
+## Playtest Core
+{% assign steps = site.data.playtest-core.steps %}
+{% for step in steps %}
+- {{ step }}
+{% endfor %}
+
+## Playtest HTTP
+{% assign steps = site.data.playtest-http.steps %}
+{% for step in steps %}
+- {{ step }}
+{% endfor %}
+
+## Playtest WireMock
+{% assign steps = site.data.playtest-wiremock.steps %}
+{% for step in steps %}
+- {{ step }}
+{% endfor %}
+
+## Playtest JDBC
+{% assign steps = site.data.playtest-jdbc.steps %}
+{% for step in steps %}
+- {{ step }}
+{% endfor %}
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/prepare.sh b/docs/prepare.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -eux pipefail
+
+cwd=$(cd "$(dirname "$0")"; pwd)
+
+pushd $cwd/..
+for pl in playtest-core playtest-http playtest-jdbc playtest-wiremock ;
+do
+  echo 'steps:' > $cwd/_data/$pl.yaml
+  mvn --no-transfer-progress clean compile -Pannotation-processing -pl=${pl} \
+      -Dorg.slf4j.simpleLogger.defaultLogLevel=error \
+      | awk '{ print "  - " $1 }' >> $cwd/_data/$pl.yaml
+done
