文章

看这里!!!教你如何创建一个基于MkDocs的简易博客网站!

看这里!!!教你如何创建一个基于MkDocs的简易博客网站!

原始链接

本文档从Gitee Issue自动生成,原文地址:Issue #ID9NER


你好啊,又见面了,这次我来教你如何创建一个简易的MkDocs博客。

创建一个空文件夹。

1
mkdir new_blogs_site

进入文件夹。

1
cd new_blogs_site

创建虚拟环境。

1
python3 -m venv venv

安装需要的库。

1
venv/bin/pip install mkdocs-material

把当前目录作为新站点。

1
mkdocs new .

修改mkdocs.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
site_name: XXX的个人博客

theme:
  name: 'material'
  palette:
    - scheme: default
      primary: light blue
      toggle:
        icon: material/lightbulb-outline
        name: 切换到深色模式
    - scheme: slate
      primary: deep purple
      toggle:
        icon: material/lightbulb
        name: 切换到浅色模式
  features:
    - navigation.tabs
    - navigation.tabs.sticky
  font:
    text: 'ZCOOL KuaiLe'
    code: 'Fira Code'

nav:
  - 首页: index.md
  - 博客: blogs/
  - 关于: about.md

创建目录结构。

1
mkdir -p docs/blogs

创建index.md

1
touch docs/index.md
1
2
3
4
5
# 首页

欢迎来到XXX的个人博客,这里记录了XXX的学习经历、工作经历、个人项目等。

我喜欢分享知识,也喜欢和人在一起。

创建about.md

1
touch docs/about.md
1
2
3
4
5
6
7
# 关于

关于XXX,XXX是一个学生,目前在XXX大学学习。

XXX很喜欢学习新的知识,也很喜欢和人在一起。

请关注XXX的个人博客,这里会分享XXX的学习经历、工作经历、个人项目等。

创建博客首页。

1
touch docs/blogs/index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# 博客

欢迎来到我的博客!这里我会分享我的学习经历、技术心得和生活感悟。

## 最新文章

*此处会显示您的博客文章*

## 文章分类

您可以将博客文章按不同主题分类,例如:
- 技术分享
- 学习笔记  
- 生活随感
- 项目经验

## 快速开始

1.`docs/blogs/` 目录下创建您的文章文件
2. 文章文件格式为 Markdown (.md)
3. 推荐的文件命名格式:`YYYY-MM-DD-文章标题.md`

### 示例文件结构
```
docs/blogs/
├── index.md          # 博客首页
├── 2024-12-01-我的第一篇博客.md
├── 2024-12-15-技术学习笔记.md
└── ...
```

---

*开始您的博客之旅,记录美好时光!*

然后你就可以欣赏你的设计了。

1
venv/bin/mkdocs serve

他会在你的机器打开一个端口8000,可以访问localhost:8000

如果你想要静态站点,你可以这样。

1
venv/bin/mkdocs build

会出现一个site目录,你可以把这个目录拿到其它需要展示的地方,比如GitHub Pages,或者自己的服务器。

如果你觉得麻烦,你可以使用我给的模板https://gitee.com/kfzay/mk-docs-blog

本文由作者按照 CC BY 4.0 进行授权