Github on Duke Hsu ｜ Learn • Build • Share

Deploy MkDocs to GitHub Pages (github.io)

Sat, 31 Jan 2026 00:00:00 +0000

1) Setup MkDocs environment

# Create MkDocs virtual environment
python3 -m venv mkdoc_venv

# Activate venv
source mkdoc_venv/bin/activate

# Deactivate venv
deactivate

# Install MkDocs + Material theme
pip3 install mkdocs mkdocs-material

# Install Mermaid plugin
pip install mkdocs-mermaid2-plugin

# Create a new MkDocs project
mkdocs new duke-note

# Run MkDocs local server
mkdocs serve

# Run server for external access
mkdocs serve --dev-addr=0.0.0.0:8000

2) Create GitHub repository

# Run in your notes directory
git init
git add .
git commit -m "Initial commit of my study notes"

3)Connect to remote GitHub repo

# Format:
# git remote set-url origin https://<token>@github.com/<owner>/<repository>.git

# Example:
git remote set-url origin https://ghp_yourTokenHere@github.com/dukehug/mkdocs_dknotes.git

git branch -M main
git push -u origin main

# Deploy to GitHub Pages
mkdocs gh-deploy

4)Deploy script (deploy.sh)

#!/bin/bash

# Stop if any error happens
set -e

# Build site
mkdocs build
sleep 10

# Push updates
git add .
git commit -m "update notes: $(date)"
git push origin main
sleep 10

# Deploy to GitHub Pages
mkdocs gh-deploy

5)Math formula support (MathJax)

References:

Git and Github 筆記

Sun, 28 Sep 2025 00:00:00 +0000

Git and Github 筆記

Git fast version control

一些基本概念
版本管理和跟蹤
版本控制系統是軟件工具
可以幫助團隊管理源代碼

Status of Version 版本狀態

Untracked 未追蹤
Tracked 已追蹤
Staged 已暫存
Committed 已提交

HEAD -> master / branch

HEAD ：目前進度，最新狀態
Master : 主線

git 追蹤的是檔案的變化，不是檔案本身

刪除檔案也需要"add" 和 “commit”

需要忽略的版本管理的文件

在projec 目錄下新增 .gitignore
在.gitignore 文件中寫入不需要進行版本管理控制的文件後綴或者文件名

Github 是平台 / 相當於Server

Git 工具將文檔或者代碼託管到github 平台 -

Install 安裝

Mac os

Mac OS 自帶 git 輸入 git -- version 就可以看到git 版本

Windows

下載最新的 https://git-for-windows.github.io/ git for windows
根據指示完成git 的安裝
完成安裝之後就可以看到git bash 的圖標

Ubuntu /Debian

根據下方命令進行安裝

$ sudo apt-get update
$ sudo apt-get install git
$ git --version

Use 使用

基礎配置

使用以下命令配置git 用戶名和電子郵件

Github上那些V2ray客户端们

Mon, 30 Aug 2021 00:00:00 +0000

Github on Duke Hsu ｜ Learn • Build • Share

Deploy MkDocs to GitHub Pages (github.io)

1) Setup MkDocs environment

2) Create GitHub repository

3)Connect to remote GitHub repo

4)Deploy script (deploy.sh)

5)Math formula support (MathJax)

Git and Github 筆記

Git and Github 筆記

Git fast version control

Status of Version 版本狀態

HEAD -> master / branch

git 追蹤的是檔案的變化，不是檔案本身

需要忽略的版本管理的文件

Github 是平台 / 相當於Server

Install 安裝

Mac os

Windows

Ubuntu /Debian

Use 使用

基礎配置

Github上那些V2ray客户端们

v2rayN（Windows）

V2rayU（Mac）

v2rayNG（Android）

Kitsunebi（Android）

BifrostV（Android）

Kitsunebi（iOS）

i2Ray（iOS）

Shadowrocket（iOS）

Pepi（iOS）

Quantumult（iOS）