贡献指南

ℹ️
本文为团队成员撰写博客/文档提供参考指南，作为非团队成员贡献欢迎提交 PR。

步骤

环境配置

  1. 安装 hugo ，参考官网教程。
  2. 安装 Git ，参考官网教程。
ℹ️
Git 相关的配置以及初始化本文不再赘述。
hugo version

若成功输出则已经安装。

克隆仓库 

git clone https://github.com/Kawaii-Chip/Kawaii-Chip.github.io.git Blog
cd Blog

新建页面

content 目录用于存放页面的源文件，通常为 markdown 格式（ .md 结尾的文件）。

这是刚开始的文件树：

      • logo.png
    • _index.md
    • about.md
    • contribute.md
    • hugo new [<parent_folder>/]<page_name>.md

    这是新建后的文件树：

    <parent_folder>/ 可以为空，这将会在 content 目录下直接创建 markdown 文件。 <page_name> 是路由名，建议言简意赅。

      • logo.png
    • _index.md
    • about.md
    • contribute.md
    • page_name.md

    • 自定义页面属性

    编辑 content/page_name.md 。

    在顶部有默认生成的 header ：

    page_name.md
    1
2
3
4
5

    ---
title: page_name
date: 2025-04-21T20:50:39+08:00
draft: true
---

    移除 draft 属性：

    page_name.md
    1
2
3
4
5

    ---
title: page_name
date: 2025-04-21T20:50:39+08:00
- draft: true
---

    其他属性

    目前已知且正在使用的属性如下：

    名称类型可选值默认值介绍
    titlestring…与文件名相同文章标题
    draftbooltrue, falsetrue是否在部署后显示该文章
    datestring…自动生成创建日期
    commentsbooltrue, falsetrue控制评论区展示
    tocbooltrue, falsetrue控制文章右侧 ‘在 GitHub 上编辑此页 →’ 显示
    weightint0, 1, 2, 3, …0控制子页面在侧边栏的顺序，数字越小排序越靠前，若为 0 则不生效

    添加页面入口至索引

    添加入口有多种方式，这里使用 cards 为例。
    编辑父目录下的 _index.md 文件，在 {{ <cards /> }} 块中添加子 {{ <card /> }} 项。

    ⚠️
    这里为什么不使用代码块进行说明？
    HTML 标签会破坏渲染，因此不使用代码块进行讲解。

    技巧

    Hextra 主题提供了更多语法支持，可以参考官方文档。
    如果有图标使用的需求，可以参考 Heroicons 和 icons.yaml 。