Hello world!¶
博客功能上线。本文将介绍博客的基本使用方法。(这是摘要部分)
这是正文。与摘要部分用<!-- more -->
分隔。
为什么添加博客¶
可以方便记录难以归类的内容,比如一些技术总结、心得体会、比赛经验、备忘事项、近期计划等。
如何添加博客¶
博客的编写相较于文档更加简单,无需考虑目录结构,只需在docs/blog/posts
目录下添加一个.md
文件即可。文件名可以是中文或英文,但不要包含空格和特殊字符。
接下来详细说明步骤:
1. 创建新文章文件
2. 在文章开头填写基本信息(元数据)
下面这个例子是一个相对完整的元数据,其中date
是文章的创建日期,authors
是作者(需要事先在docs/blog/.authors.yml
填写基本信息),categories
是文章的分类,可以有多个,用于自动归档。
3. 编写标题、摘要、正文
摘要和正文之间用<!-- more -->
分隔。
4. 保存、预览并提交
具体流程和编写常规文档一致,只不过不需要额外编辑mkdocs.yml
的nav
部分。
如何添加作者¶
修改docs/blog/.authors.yml
文件,按照下面的格式添加即可。
写文章时只需要在最开头的元数据中的authors
填写your_alias
即可。(注:your_alias
可以是任意别名,比如lcf
)