この記事は研究室向けに書かれたものです!

環境構築時の事を思い出しながら書いているのでこの記事を過信し過ぎないように!

前提

  • OS: MacOS Sonoma(14.1.2)
  • Homebrew: 4.2.14

環境構築

何はともあれ,ローカルに環境が無いと何も始まらないので環境を構築します.

  1. Rubyのインストール
    brew install rbenv
    

    3.3.0のところは任意のバージョンで可

    rbenv install 3.3.0
    

    インストール可能なRubyのバージョンを知りたければ以下のコマンドを実行する

    rbenv install -l 
    
    rbenv global 3.3.0
    
  2. Jekyllに必要なものをインストール
    gem install bundler jekyll
    

    本来ならJekyllの設定等がありますが今回はサイトの保守管理の為の記事なので割愛します

  3. リポジトリのクローン
    git clone https://github.com/NITItohLab/nititohlab.github.io.git
    

    gitの説明は世に溢れているのでここではしない.

  4. GitHub側の設定 おそらく,リポジトリにPushする権限が無いので,リポジトリを開いて設定する.
    Settingsを開き,サイドバーにあるAccessからCollaboratorsを選択する.
    Manage accessの横にあるAdd Peopleを押し,追加したいユーザのGitHubのユーザネームを入力し,Select a collaborator aboveを押す.
    以下の参考にしたサイトも参考にされたし.

サイトの構成

.
├── 404.html <- 404ページ.本来404.mdがあれば良いが,カスタムしたかったので独立させている.一度404ページを見てみよう!
├── Gemfile <- 気にするな
├── Gemfile.lock <- 気にするな
├── _config.yml <- 気にするな
├── _data
│   ├── authors.yml <- サイトの記事を書いた著者のデータが入っている
│   ├── navigation.yml <- ヘッダーやサイドバーの項目に関するデータ
│   └── ui-text.yml <- サイトの言語を日本語にするためのデータ
├── _pages <- ページ一覧.フロントページを始めとしたページのデータが含まれている
│
├── _posts <- 記事一覧.この記事もここに存在する
│
├── _site <- サイトのデータ.デプロイ時に自動更新されるので触らなくて良い
│
└── assets <- このサイトで用いられている画像等のリソースが入っている

サイトの保守

Jekyllのルートでこのコマンドを実行することでサーバが立ち上がる

   bundle exec jekyll serve

サーバが立ち上がったらlocalhost:4000でアクセスできる.

ページの追加等は他のMarkdownファイルを参考にいい感じにやってください.

参考にしたサイト

rbenvでrubyのバージョンを管理する
コラボレーターを個人リポジトリに招待する
Minimal Mistakes <- このサイトで使われているテーマのドキュメント.困ったらだいたいここを見れば解決する.