Skip to content

使用 MkDocs 构建博客

MkDocs 是一个简单易用的静态站点生成器,可以帮助你快速构建漂亮的博客。在本文中,我将向你介绍如何使用 MkDocs 来搭建博客,并使用一些常用插件。

安装 MkDocs

首先,你需要安装 MkDocs。你可以通过以下命令使用 pip 安装 MkDocs:

pip install mkdocs

安装完成后,你可以通过运行以下命令来验证安装是否成功:

mkdocs --version

创建新的博客项目

接下来,你需要创建一个新的 MkDocs 项目。请按照以下步骤进行操作:

  1. 在你的工作目录中创建一个新的文件夹,用于存放博客项目。
  2. 打开命令行终端,并进入到该文件夹中。
  3. 运行以下命令来创建一个新的 MkDocs 项目:
mkdocs new my-blog

这将在当前文件夹中创建一个名为 my-blog 的新项目。

  1. 进入到 my-blog 文件夹中:
cd my-blog

编辑博客内容

现在,你可以开始编辑你的博客内容了。在 my-blog 文件夹中,你会看到一个名为 docs 的文件夹,这是用于存放博客文章的地方。

你可以在 docs 文件夹中创建 Markdown 格式的文件来撰写你的博客文章。每个 Markdown 文件将对应生成一个网页。

编辑完成后,你可以使用以下命令来预览你的博客:

mkdocs serve

这将启动一个本地服务器,并在浏览器中显示你的博客。你可以通过访问 http://localhost:8000 来查看。

安装和使用常用插件

MkDocs 支持许多有用的插件,可以增强你的博客功能。其中一个常用插件是 gh-deploy,它可以帮助你将博客部署到 GitHub Pages。

要安装 gh-deploy 插件,请运行以下命令:

pip install mkdocs-gh-deploy

安装完成后,你可以使用以下命令将你的博客部署到 GitHub Pages:

mkdocs gh-deploy

这将自动将你的博客构建为静态网站,并将其发布到 GitHub Pages 上。

除了 gh-deploy 插件外,还有许多其他有用的插件可供选择。你可以在 MkDocs 的官方文档中找到更多插件和使用说明。

希望这篇文章对你有所帮助!祝愉快地构建和管理你的博客!


Last update: November 26, 2023