跳到主要内容

macOS安装Mkdocs

安装Mkdocs​

  1. 安装python3（可能已经预装好来）
python3 --version
  1. 安装pip3（可能已经预装好来）
pip3 --version
# 安装新的pip3，过早的版本无法安装mkdocs
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3 get-pip.py
  1. 安装mkdocs
pip3 install mkdocs
$ mkdocs --version                                                                                                            
zsh: command not found: mkdocs
  1. 修改profile file
vim ~/.zshrc
export PYTHON_HOME=/Users/mqy/Library/Python/3.9
export PATH=$PATH:$PYTHON_HOME/bin
source ~/.zshrc
$ mkdocs --version 
mkdocs, version 1.4.2 from /Users/mqy/Librarsy/Python/3.9/lib/python/site-packages/mkdocs (Python 3.9)
  1. 创建笔记目录
mkdocs new my_note
cd my_note
$ tree -L 3
.
├── docs
│   └── index.md
└── mkdocs.yml

2 directories, 2 files
  1. 启动mkdocs server
$ mkdocs serve
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 0.03 seconds
INFO     -  [18:47:24] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [18:47:24] Serving on http://127.0.0.1:8000/
  1. 访问页面
http://127.0.0.1:8000/

安装主题​

  1. 安装主题
pip3 install mkdocs-material
  1. 使用主题
# 修改mkdocs.yml
site_name: mqy9174583
theme:
    name: "material"

设置index​

参考 https://mkdocs-like-code.readthedocs.io/zh_CN/latest/MkDocs-advanced-operations/files-layout/

直接创建目录及文件即可，无需修改mkdocs.yml，docs下面的目录结构，页面上会原封不动的显示出来。

部署到github​

# 前提:当前目录上是github上的一个参数
mkdocs gh-deploy