Skip to content

How to use Student Template mkdocs

Terminal

yuichi@MacBookAir-M2 ~ % cd repos
yuichi@MacBookAir-M2 repos % ls
fa24_kannai_site
yuichi@MacBookAir-M2 repos % git clone git@gitlab.fabcloud.org:academany/fabacademy/2025/labs/kannai/site.git fa25_kannai_site
yuichi@MacBookAir-M2 repos % ls
fa24_kannai_site
fa25_kannai_site
yuichi@MacBookAir-M2 repos % cd fa25_kannai_site 
yuichi@MacBookAir-M2 fa25_kannai_site % ls -la
drwxr-xr-x   3 yuichi  staff   96  1 23 11:38 .
drwxr-xr-x  14 yuichi  staff  448  1 23 11:38 ..
drwxr-xr-x   9 yuichi  staff  288  1 23 11:38 .git
yuichi@MacBookAir-M2 fa25_kannai_site % touch README.md
yuichi@MacBookAir-M2 fa25_kannai_site % ls                                 
README.md
yuichi@MacBookAir-M2 fa25_kannai_site % git add README.md         
yuichi@MacBookAir-M2 fa25_kannai_site % git status
On branch main

No commits yet

Changes to be committed:
  (use "git rm --cached <file>..." to unstage)
    new file:   README.md
yuichi@MacBookAir-M2 fa25_kannai_site % git commit -m "add README"
yuichi@MacBookAir-M2 fa25_kannai_site % git push --set-upstream origin main
alt text

Student template MkDocs

https://gitlab.fabcloud.org/academany/fabacademy/templates/student-template-mkdocs

alt text

yuichi@MacBookAir-M2 fa25_kannai_site % open .

Note

Show hidden file (macOS)
Command (⌘) + Shift (⇧) + .

alt text

yuichi@MacBookAir-M2 fa25_kannai_site % git status
On branch main
Your branch is up to date with 'origin/main'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
    docs/
    mkdocs.yml
    requirements.txt
yuichi@MacBookAir-M2 fa25_kannai_site % git add .
yuichi@MacBookAir-M2 fa25_kannai_site % git commit -m "add template"
yuichi@MacBookAir-M2 fa25_kannai_site % git push

alt text

alt text
alt text https://academany.fabcloud.io/fabacademy/2025/labs/kannai/site https://fabacademy.org/2025/labs/kannai/

alt text

Local server

yuichi@MacBookAir-M2 fa25_kannai_site % mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 0.23 seconds
INFO     -  [12:34:57] Serving on
            http://127.0.0.1:8000/fabacademy-student-template/

alt text

Note

Install mkdocs 

% pip install mkdocs
% cd repos/my_repo
% ls
requirements.txt
% pip install -r requirements.txt
If you don’t have pip, install it 
% python3 --version
Python 3.9.6
% python3 get-pip.py