MkDocs Simple Blog 项目启动与配置教程

1. 项目目录结构及介绍

MkDocs Simple Blog 是一个基于 MkDocs 的简单博客生成器。以下是项目的目录结构及其说明：

mkdocs-simple-blog/
├── docs/                   # MkDocs 文档目录
│   ├── about.md            # 关于页面
│   ├── archive.md          # 归档页面
│   ├── index.md            # 主页
│   ├── licenses.md         # 许可证信息
│   ├── posts/              # 文章目录
│   │   ├── my-first-post.md   # 第一篇文章
│   │   └── my-second-post.md  # 第二篇文章
│   ├── resources/          # 资源目录
│   └── template/           # 模板目录
├── mkdocs.yml              # MkDocs 配置文件
└── requirements.txt        # 项目依赖文件

• docs/: 包含所有 Markdown 文件，这些文件会被 MkDocs 转换为 HTML 页面。
• docs/about.md: 关于页面内容。
• docs/archive.md: 归档页面内容。
• docs/index.md: 主页内容。
• docs/licenses.md: 项目使用许可证信息。
• docs/posts/: 存放博客文章的目录。
• docs/resources/: 存放静态资源的目录，如图片、CSS、JavaScript 文件等。
• docs/template/: 存放自定义模板的目录。
• mkdocs.yml: MkDocs 配置文件，用于定义项目的配置。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。

2. 项目的启动文件介绍

MkDocs Simple Blog 项目的启动主要是通过命令行操作。以下是启动项目的基本步骤：

1. 克隆项目到本地：

   git clone https://github.com/FernandoCelmer/mkdocs-simple-blog.git
   cd mkdocs-simple-blog
   

2. 安装项目依赖：

   pip install -r requirements.txt
   

3. 启动本地服务器预览：

   mkdocs serve
   

执行上述命令后，MkDocs 将在本地启动一个服务器，并自动在浏览器中打开一个新标签页，地址通常是 http://127.0.0.1:8000，你可以在浏览器中查看你的博客。

3. 项目的配置文件介绍

项目的配置文件是 mkdocs.yml，该文件用于定义 MkDocs 项目的配置，包括文档的标题、主题、导航结构等。以下是 mkdocs.yml 的基本结构：

site_name: MkDocs Simple Blog
nav:
    - Home: index.md
    - About: about.md
    - Archive: archive.md
    - Licenses: licenses.md

• site_name: 网站名称，显示在页面的标题栏。
• nav: 定义导航菜单，包含页面名称和对应的 Markdown 文件路径。

你可以根据需要自定义 mkdocs.yml 文件，添加更多配置选项，例如主题、插件等。