mkdocs 使用简介

• mkdocs getting-started

语法支持：

• markdown 标准语法
• mermaid 代码块

install

apt install python3-pip
python3 -m pip install mkdocs-material

# 使用清华源
python3 -m pip install mkdocs-material -i https://pypi.tuna.tsinghua.edu.cn/simple/

---

create and run

mkdir test && cd test 

mkdocs new .
mkdocs serve

• now can browser over localhost:8000

---

build

mkdocs build

• will build into site directory

---

publish to github

• github workflows
• publishing-your-site

name: ci 
on:
  push:
    branches:
      - master 
      - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: ~/.cache 
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-material 
      - run: mkdocs gh-deploy --force

---

TODO: 示例