跳转至

在 Ubuntu 上安装 MkDocs

0. 简介

MkDocs 是一个用于生成静态页面的开源框架,基于 Python 开发。

1. 安装依赖

安装基础依赖:

sudo apt install -y --no-install-recommends git git-lfs python3 pip 

如果需要启用 social 插件:

sudo apt install -y --no-install-recommends libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant

2. 安装 MkDocs 及相关依赖

pip install pip install --no-cache-dir --break-system-packages \
  mkdocs-material \
  mkdocs-git-revision-date-localized-plugin \
  mkdocs-git-authors-plugin \
  mkdocs-rss-plugin \
  mkdocs-material[imaging]

3. 配置 mkdocs.yml

配置 mkdocs.yml 文件。

详细说明参考:Material for MkDocs

4. 编写博客

在目录中创建 *.md 文件。

5. 构建和部署

使用以下命令构建博客:

mkdocs build

使用以下命令部署博客:

mkdocs gp-deploy

Ref

[1]. Ubuntu依赖解析和安装