Skip to content

ZhaoCake/zhaocake.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZhaoCake 博客文档指南 (by claude-3.7-sonnet)

这个仓库包含我基于 MkDocs 构建的个人博客。本 README 作为维持博客文章一致性的参考指南。

博客文章结构

必需的前置信息

每篇博客文章应以包含以下字段的 YAML 前置信息开始:

---
draft: false           # 是否为草稿(true/false)
date: YYYY-MM-DD       # 发布日期,格式为 YYYY-MM-DD
authors:
  - ZhaoCake           # 作者名称
categories:
  - 分类名称            # 一个或多个文章分类
---

文章结构

  1. 标题:以一级标题(#)开始文章标题
  2. 简介:简短介绍文章主题
  3. 摘要标记:在简介后添加 <!-- more --> 以创建文章列表中的摘要
  4. 主要内容:使用二级及以上标题(##### 等)组织内容
  5. 结论/结尾:可选的总结或结束语

示例模板

---
draft: false
date: YYYY-MM-DD
authors:
  - ZhaoCake
categories:
  - 分类名称
---

# 文章标题

简短介绍文章内容的段落。

<!-- more -->

## 章节标题

主要内容在这里...

### 子章节

更多内容...

## 结论

总结想法...

内容分类

根据现有的文章,常用的分类有:

  1. 资源安利 - 资源推荐和工具
  2. 环境管理 - 环境配置和设置
  3. 编程工具 - 编程工具和实用程序
  4. 心得体会 - 经验和感悟
  5. 读书笔记 - 阅读笔记
  6. 项目分享 - 项目分享
  7. 计算机原理 - 计算机科学原理

特殊元素

提示和告示

!!! note "标题"
    提示内容

代码块

```bash
# 你的代码

### 图片

```markdown
![替代文本](../../assert/图片文件名.png)

文件命名约定

文件通常使用日期格式命名:

  • 主要文章:YYYY-MM-DD.md
  • 同一天的多篇文章:YYYY-MM-DD-N.md(其中 N 是数字)

目录结构

  • 博客文章位于:docs/blog/posts/
  • 图片和其他资源存储于:docs/assert/

常见文章主题

你的博客包含关于以下内容的文章:

  1. 环境配置和管理
  2. 编程工具和资源
  3. 项目经验和分享
  4. 读书笔记和感悟
  5. 技术教程和详细示例

About

My blog.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •