Skip to content

MkDocs

安裝 MkDocs

  • pip install mkdocs
  • pip install mkdocs-material

操作指令

  • mkdocs new [dir-name] - 新建專案
  • mkdocs serve - 啟動網站伺服器。文件變更後即時重整更新頁面
  • mkdocs build - 建立靜態文件網站。可以部署至 GitHub
  • mkdocs -h - 指令說明

mkdocs.yml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
site_name: 古典密碼
nav:
    - Home: index.md
    - MkDocs: mkdocs.md
    - Python 基礎: basic.md
    - ASCII 編碼: ascii.md
    - 凱撒密碼: caesar.md
    - 維吉尼亞密碼: vigenere.md
    - 關於本站: about.md
theme:
    name: material
    features:
        - content.code.copy
    highlightjs: true
    palette:
        - scheme: default
          primary: black
          accent: black
markdown_extensions:
    - attr_list
    - pymdownx.highlight:
        linenums: true
    - pymdownx.superfences
extra_css:
    - css/main.css

main.css

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
body * {
    font-size: 18px;
    font-family: Consolas;
}

h1 {
    color: #546d78 !important;
    font-size: 28px !important;
    font-weight: bold !important;
}

h2 {
    color: #4051b5 !important;
    font-size: 20px !important;
    font-weight: bold !important;
}

h3 {
    color: #3b86b6 !important;
    font-size: 18px !important;
    font-weight: bold !important;
}