Skip to content

个人笔记

使用的静态站点生成器是 Mkdocs materials

参考了教程 Getting Started with Material for MkDocs

  • 通过输入 python -m venv venv 设置 Python 虚拟环境

  • 使用 .\venv\Scripts\activate 激活虚拟环境

  • 安装 mkdocs-material pip install mkdocs-material

命令 🤔

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

项目结构 🐸

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.