How to edit this webpage

Preparation

(Assuming Mac OS X)

1. install mkdocs

    pip install mkdocs mkdocs-awesome-nav
    pip install mkdocs-material
   

   You may need to install/update python as well.

    Brew install python
    pyenv install 3.13.2t
    pyenv global 3.13.2t
   

2. clone git repository

   cd <to some directory as you want to place the files>
   

   git clone http://www.cns.s.u-tokyo.ac.jp/gitlab/shimiz/all-about-crib-mkdocs.git
   

   Directory is made as: all-about-crib-mkdocs

Edit and update

First of all, get an agreement on your update with the web page managers (now Shimizu/Yamaguchi).

1. Get latest files from the git repository

   cd <to the directory you placed the files> 
   git pull
   

   If it does not work, you may need to do like:

   git remote add origin  http://www.cns.s.u-tokyo.ac.jp/gitlab/shimiz/all-about-crib-mkdocs.git
   git branch --set-upstream-to=origin/main main
   

2. Edit the files in docs/

3. update git repository

   git add .
   git commit -m '[Some message for updating]'
   git push
   

4. test web page

   mkdocs serve
   

   -> http://localhost:8000 shows the updated pages. (Changes in the files immediately reflected to the pages.)

5. build web pages

   mkdocs build
   

   -> static html flies are made in ./site

6. rsync

   rsync -auv site www-intra:/home/httpd/html/crib/crib-new/