开源项目 XS-Leaks Wiki 使用指南

1. 项目目录结构及介绍

开源项目 XS-Leaks Wiki 的目录结构如下所示：

xsleaks/wiki
├── .github/            # GitHub 工作流文件
│   └── workflows/
├── archetypes/         # Hugo 模板文件
├── content/            # 内容文件，如文章、页面等
├── themes/             # Hugo 主题
│   └── book/
├── .gitignore          # Git 忽略文件
├── CODE_OF_CONDUCT.md  # 项目行为准则
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├── config.toml         # Hugo 配置文件

• .github/: 存放与 GitHub 工作流相关的文件，如自动化构建和部署的配置。
• archetypes/: Hugo 模板文件，用于生成新文章的模板。
• content/: 包含所有内容文件，如文章、页面等。
• themes/: 存放 Hugo 主题文件，本项目使用的是 book 主题。
• .gitignore: 指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md: 项目行为准则文件，定义了项目参与者的行为规范。
• LICENSE: 项目使用的许可证文件，本项目使用 Apache-2.0 许可。
• README.md: 项目说明文件，介绍了项目的相关信息。
• config.toml: Hugo 配置文件，用于配置网站的基本信息和主题设置。

2. 项目的启动文件介绍

项目的启动主要是通过 Hugo 来构建静态网站。在项目根目录下执行以下命令：

hugo server --minify

这条命令会启动 Hugo 的本地服务器，并且开启压缩。在浏览器中访问 http://localhost:1313（或者 hugo 输出的指定端口），即可看到网站内容。

3. 项目的配置文件介绍

项目的配置主要通过 config.toml 文件进行。以下是配置文件的一些基本设置：

baseURL = "https://xsleaks.dev"
languageCode = "zh-CN"
title = "XS-Leaks Wiki"
theme = "book"

[params]
  description = "一个关于信息泄露和浏览器侧通道攻击的开源知识库"

[menu]
  [[menu.main]]
    name = "首页"
    weight = -1
    identifier = "index"
    url = "/"
  [[menu.main]]
    name = "文章"
    weight = 1
    identifier = "posts"
    url = "/posts/"

• baseURL: 设置网站的根 URL。
• languageCode: 设置网站的语言代码，本项目使用中文。
• title: 设置网站标题。
• theme: 设置 Hugo 主题，本项目使用 book 主题。
• params: 自定义参数，如网站描述。
• menu: 配置网站菜单，包括菜单名称、权重、标识符和链接。

通过修改 config.toml 文件，可以调整网站的布局、样式和功能。