mkdocs搭建Cloudflare Pages网站

个人需求

把markdown文档放到一个目录，能自动索引生存静态网站。

首先尝试使用hugo，发现不少模版跟最新版本的hugo不兼容。

后来又尝试了vitepress,没有发现自动indexs的模块。

最后选择了mkdocs-material。

安装 mkdocs-material

• brew install mkdocs-material - 苹果mac用户安装 mkdocs-material。
• mkdir 9763.org && cd 9763.org - 建立对应的目录文件夹。
• mkdocs new . - 在当前目录新建一个站点。
• mkdocs serve - 启动服务器，用于本地开发测试。
• mkdocs build - 生成静态内容到site文件夹。
• mv site/* /var/www/html/ - 发布静态页面到web服务器。

配置文件 mkdocs.yml

site_name: 9763.org
site_url: https://9763.org
theme:
  name: material
  logo: logo.png
  favicon: favicon.png
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.prune
    - navigation.footer
markdown_extensions:
  - attr_list
plugins:
  - tags:
      tags_file: tags.md
extra:
  generator: false
copyright: 9763.org

发布到Cloudflare Pages

• 链接到github repo
• 选择 mkdocs framework
• 把mkdocs-material==9.5.49添加到根目录下requirements.txt
• 添加环境变量 PYTHON_VERSION 3.13

相关链接

mkdocs.org 是基于python的静态网站生成器。

mkdocs-material是mkdocs的模版。