Skip to content

Build a personal site

Attention

setup git first

Markdown and HTML

  • Markdown is a lightweight markup language for creating formatted text using a plain-text editor.
  • HTML is the standard markup language for documents designed to be displayed in a web browser.

Repository

Remote Repository (gitlab, fabcloud)

https://gitlab.fabcloud.org/academany/fabacademy/2024/labs/kannai

Alt text

Local Repository (your PCs)

PS C:\Users\yuichi> pwd
Path
----
C:\Users\yuichi

PS C:\Users\yuichi> mkdir repos
    Directory: C:\Users\yuichi
Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d-----        2024/01/19     22:16                repos

PS C:\Users\yuichi> cd repos
PS C:\Users\yuichi\repos> ls
PS C:\Users\yuichi\repos> git clone git@gitlab.fabcloud.org:academany/fabacademy/2024/labs/kannai/students/your-name.git

PS C:\Users\yuichi\repos> ls
    Directory: C:\Users\yuichi\repos
Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d-----        2024/01/19     22:20                your-name

PS C:\Users\yuichi\repos> cd your-name
PS C:\Users\yuichi\repos\your-name> tree /f
C:.
│  .gitlab-ci.yml
│  README.md
│
└─public
    │  404.html
    │  about.html
    │  final-project.html
    │  index.html
    │  style.css
    │
    ├─assignments
    │      week01.html
    │
    └─images
            avatar-photo.jpg
            sample-photo.jpg

yuichi@MacBookAir-M2 ~ % pwd
/Users/yuichi
yuichi@MacBookAir-M2 ~ % ls
yuichi@MacBookAir-M2 ~ % mkdir repos
yuichi@MacBookAir-M2 ~ % ls
repos
yuichi@MacBookAir-M2 ~ % cd repos
yuichi@MacBookAir-M2 repos % git clone git@gitlab.fabcloud.org:academany/fabacademy/2024/labs/kannai/students/your-name.git
yuichi@MacBookAir-M2 repos % cd your-name
yuichi@MacBookAir-M2 your-name % tree
.
└── your-name
    ├── README.md
    └── public
        ├── 404.html
        ├── about.html
        ├── assignments
        │   └── week01.html
        ├── final-project.html
        ├── images
        │   ├── avatar-photo.jpg
        │   └── sample-photo.jpg
        ├── index.html
        └── style.css

Install Text Editor

Markdown

PS C:\Users\yuichi> cd repos
PS C:\Users\yuichi\repos> git clone git@gitlab.fabcloud.org:academany/fabacademy/templates/student-template-mkdocs.git

PS C:\Users\yuichi\repos> ls
    Directory: C:\Users\yuichi\repos

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d-----        2024/01/19     22:58                student-template-mkdocs
d-----        2024/01/19     22:34                your-name

PS C:\Users\yuichi> python --version
Python 3.12.1
PS C:\Users\yuichi> py --list
 -V:3.12-arm64 *  Python 3.12 (ARM64)

PS C:\Users\yuichi> pip --version
pip 23.3.2 from C:\Users\yuichi\AppData\Local\Programs\Python\Python312-arm64\Lib\site-packages\pip (python 3.12)

PS C:\Users\yuichi> pip install mkdocs

PS C:\Users\yuichi> pip list
Package         Version
--------------- -------
mkdocs          1.5.3

PS C:\Users\yuichi> mkdocs --version
mkdocs, version 1.5.3 from C:\Users\yuichi\AppData\Local\Programs\Python\Python312-arm64\Lib\site-packages\mkdocs (Python 3.12)
PS C:\Users\yuichi> where.exe mkdocs
C:\Users\yuichi\AppData\Local\Programs\Python\Python312-arm64\Scripts\mkdocs.exe
PS C:\Users\yuichi> pip show mkdocs
Name: mkdocs
Version: 1.5.3
Summary: Project documentation with Markdown.
Home-page:
Author:
Author-email: Tom Christie <tom@tomchristie.com>
License:
Location: C:\Users\yuichi\AppData\Local\Programs\Python\Python312-arm64\Lib\site-packages
Requires: click, colorama, ghp-import, jinja2, markdown, markupsafe, mergedeep, packaging, pathspec, platformdirs, pyyaml, pyyaml-env-tag, watchdog
Required-by:

Note

Installing Python from https://www.python.org/ with Add python.exe to PATH checked

Alt text

Mkdocs serve
Last update: January 22, 2024