Skip to content

发布文章与基本配置

页面配置♪

新建项目后，您会在文件夹内发现一个叫做 mkdocs.yml 的文件。对其进行编辑：

YAML
1
2
site_url: your_site_url
site_name: your_site_name

其中 your_site_url 为您的网站的网址，而 your_site_name 为您希望自己网站的名字。

例如我的就是：

YAML
1
2
site_url: https://catalan1906.github.io
site_name: Catalan1906 的杂货间

新建一个页面♪

首先我们需要知道，我们编辑的内容全部在 docs 文件夹中进行，site 文件夹是不需要动的。

mkdocs 的文档采用 Markdown 格式化。如果您希望新文章的网址为 site_url/a/b/c/.../d/article_name/ ，那么有两种方法可以实现：

  1. 在 docs 文件夹内，依次建立 a, b, c, ..., d 文件夹，之后建立 article_name.md，在其中编辑内容即可。

  2. 在 docs 文件夹内，依次建立 a, b, c, ..., d, article_name 文件夹，之后建立 index.md，在其中编辑内容即可。（注：编辑网站主页只能采用该方法）

编辑好内容后，在项目文件夹内打开 cmd，执行以下命令：

Bash
1
mkdocs serve

注：serve 命令实时修改实时更新，错误和警告会实时弹出，方便调试使用。

这时会出现提示：Serving on local_url 或者 Browser connected: local_url（其中 local_url 为本地预览地址，一般为 http://127.0.0.1:8000/ ），打开之后您就能查看您的修改了。

例如您在上述过程中新建的文章，可以访问 local_url/a/b/c/.../d/article_name/ 来查看。

配置目录♪

在 mkdocs.yml 文件中，新建 nav 词条并进行编辑：

YAML
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
nav: 
- title1: 
  - title1-1: url1-1
  - title1-2: 
    - title1-2-1: url1-2-1
    - title1-2-2: url1-2-2
    - title1-2-3: url1-2-3
    - title1-2-4: url1-2-4
- title2: 
  - title2-1: 
    - title2-1-1: url2-1-1
    - title2-1-2: url2-1-2

在上述例子中，根据缩进形成了多级目录的结构。其中，title 为您希望设置的文章的标题，url 为该文章的网址。在很多主题中，最外层的标题会单独列出为一个大板块。

上传文件♪

如果经验充足或者直觉很好，您应该已经发现如何上传了：和新建页面的方法类似，只需将 .md 文件换成您希望上传的文件即可。

例如，我希望在 site_url/a/b/c/.../d/ 上传 file.zip 文件，那么在 docs/a/b/c/.../d/ 内放置 file.zip 即可，最终文件将上传为 site_url/a/b/c/.../d/file.zip。