Hello-CTF 项目使用教程

Hello-CTF 项目使用教程

Hello-CTF【Hello CTF】题目配套，免费开源的CTF入门教程，针对0基础新手编写，同时兼顾信息差的填补，对各阶段的CTFer都友好的开源教程，致力于CTF和网络安全的开源生态！项目地址:https://gitcode.com/gh_mirrors/he/Hello-CTF

1. 项目的目录结构及介绍

Hello-CTF 项目的目录结构如下：

Hello-CTF/
├── docs/
│   ├── _includes/
│   ├── _layouts/
│   ├── assets/
│   ├── quickstart/
│   ├── ctf/
│   ├── writeups/
│   ├── resources/
│   └── README.md
├── .github/
├── .gitignore
├── LICENSE
├── README.md
├── mkdocs.yml
└── requirements.txt

目录介绍

• docs/: 包含项目的文档内容，分为多个子目录，如 quickstart, ctf, writeups, resources 等。
• _includes/: 包含文档中使用的部分模板。
• _layouts/: 包含文档的布局模板。
• assets/: 包含文档所需的静态资源，如图片、CSS 和 JavaScript 文件。
• .github/: 包含 GitHub 相关的配置文件，如 Actions 等。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍文档。
• mkdocs.yml: MkDocs 的配置文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

Hello-CTF 项目使用 MkDocs 来构建和部署文档。主要的启动文件是 mkdocs.yml，它包含了 MkDocs 的配置信息。

mkdocs.yml

site_name: Hello CTF
theme:
  name: material
nav:
  - 快速开始: 'quickstart.md'
  - CTF: 'ctf.md'
  - Writeups: 'writeups.md'
  - Resources: 'resources.md'
plugins:
  - search
  - autorefs
markdown_extensions:
  - admonition
  - codehilite
  - toc:
      permalink: true

启动步骤

1. 安装依赖：

   pip install -r requirements.txt
   

2. 启动本地服务器：

   mkdocs serve
   

3. 访问本地服务器：

   http://127.0.0.1:8000
   

3. 项目的配置文件介绍

Hello-CTF 项目的主要配置文件是 mkdocs.yml，它包含了 MkDocs 的配置信息，如站点名称、主题、导航栏、插件和 Markdown 扩展等。

mkdocs.yml 配置项介绍

• site_name: 站点名称，显示在页面标题和导航栏。
• theme: 使用的主题，这里使用的是 material 主题。
• nav: 导航栏配置，定义了各个页面的链接。
• plugins: 使用的插件，如搜索插件 search 和自动引用插件 autorefs。
• markdown_extensions: Markdown 扩展配置，如提示框 admonition、代码高亮 codehilite 和目录生成 toc。

通过这些配置，可以自定义站点的外观和功能，使其更符合项目需求。

---

以上是 Hello-CTF 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

Hello-CTF【Hello CTF】题目配套，免费开源的CTF入门教程，针对0基础新手编写，同时兼顾信息差的填补，对各阶段的CTFer都友好的开源教程，致力于CTF和网络安全的开源生态！项目地址:https://gitcode.com/gh_mirrors/he/Hello-CTF