今井研のB4向け新人研修のためのドキュメントページです．
https://www.ailab.ics.keio.ac.jp/b4_induction_training/
- 2020/02/03 - サイト作成
- 2020/02/11 - ホスティング開始
- 2020/03/31 - 2020年度の新人研修終了
- 2021/02/08 - master-2021ブランチ作成．引き継ぎ
- 毎年，新B4向けに行なっている新人研修の内容をWebサイト（ドキュメントページ）としてまとめたもの．
- 今現在(2021/02)，Rubyベースの静的サイトジェネレータJekyllを使ってビルドされているが，実体(サイトコンテンツ)は
docs以下に全てある．他のビルドツール（例えばsphinx）を使っても良いと思う． - Web周りの技術は隆盛が激しいので，各年の運用は担当者に任せる．
とりあえず，uchiumi(@yumaloop)に連絡してください．
- このサイトは，Rubyベースの静的サイトジェネレータJekyllを使ってビルドされている.
- デザインテーマはjust-the-docsを使っている．
- サーバはGitHub PagesというGithub公式の無料サービスを使っている．
以下を使える環境を用意する．
- ruby # スクリプト言語
- bundler # :gem, gemをまとめて管理するツール(これもgem)
- jekyll # :gem, 静的サイトジェネレータ(markdownファイルをhtmlに自動変換)
※ gem: rubyのライブラリの総称．
※ Gemfile: 必要なgemのバージョンリストが書かれたファイル．
macOSの場合
詳しくは，Jekyll公式ドキュメントを参照してください．
# Command Line Tools for Xcodeをインストールする
$ xcode-select --install
# Rubyをインストールする
$ brew install ruby # homebrewでrubyをインストール
$ echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile # pathを追加
$ ruby -v # チェック
ruby 2.7.1p83 (2020-03-31 revision a0c7c23c9c)
# bundlerとjekyllをローカルインストールする
$ gem install --user-install bundler jekyll
$ echo 'export PATH="$HOME/.gem/ruby/X.X.X/bin:$PATH"' >> ~/.bash_profile # pathを追加(X.X.Xにはrubyのversionを入れる)
# bundleコマンドでGemfileに書かれた必要なgemを一括インストール
$ bundle install
- ローカルへレポジトリをコピーする．
$ git clone https://github.com/imai-laboratory/b4_induction_training.git
docsディレクトリ以下の内容を変更する．本文はMarkdownファイル．必要な場合，画像やPDFを追加する．詳しくは，Jekyll公式ドキュメントを読む．
$ tree .
docs
├── devops
│ ├── bash.md
│ ├── devops.md
│ ├── dockder.md
│ ├── git.md
│ └── img
├── dl
│ ├── dl.md
│ ├── dl_fromscratch.md
│ ├── dl_fromscratch.pdf
│ ├── mnist.md
│ └── mnist_notebook.html
├── jekyll
├── ml
│ ├── 1.introductiion.md
│ ├── 2.linear_regression.md
│ ├── ...
│ └── img
├── nlp
│ ├── dl_fromscratch2_nlp.md
│ ├── dl_fromscratch2_nlp.pdf
│ └── nlp.md
├── nvidia-gpu
│ ├── cudacudnn.md
│ ├── nvidia-gpu.md
│ └── ubuntu.md
├── python
│ ├── python.md
│ ├── python_exercise.md
│ └── python_tutorial.md
├── rl
│ ├── references.md
│ └── rl.md
├── stat
│ ├── 1.probability.md
│ ├── 2.variable_and_expectation.md
│ ├── ...
│ └── img
└── tex
├── sample
└── tex.md
- localhostでサーバを立てて確認．
bundle exec jekyll serveコマンドでサーバを立てる．http://127.0.0.1:4000/ をブラウジングして変更を確認．
※ruby3系だと上手く動かない可能性があるので注意
$ bundle exec jekyll serve
Configuration file: path/to/b4_induction_training/_config.yml
Source: path/to/b4_induction_training
Destination: path/to/b4_induction_training/_site
Incremental build: disabled. Enable with --incremental
Generating...
Jekyll Feed: Generating feed for posts
done in 6.245 seconds.
Auto-regeneration: enabled for '/path/to/b4_induction_training'
Server address: http://127.0.0.1:4000/
Server running... press ctrl-c to stop.git pushしてリモートリポジトリへ変更を反映.
$ git add .
$ git commmit -m "message"
$ git push origin master-2021各年度のサイトコンテンツの完成版はmaster-xxxxブランチで管理する（例: 2020年度のサイトはmaster-2020ブランチで管理）．
リポジトリのSettings > GitHub Pages > Sourceから，
どのブランチをデプロイするか，を選択できる．
$ git checkout -b master-2099 # 新しいブランチを作成して移動