Skip to content

Commit cfadd6e

Browse files
author
Jarcis-cy
committed
[add] 补充文档使用方法
1 parent ec500d4 commit cfadd6e

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

_coverpage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
[xray使用指南](/tutorial/introduce)
55
[xpoc使用指南](/xpoc/QuickStart.md)
6-
[开发者指南](/guide/README.md)
6+
[开发者指南](/guide/QuickStart.md)
77
[高级版/企业版](/generic/compare.md)
88

99
![](/assets/00000.png)

guide/use.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# 文档使用方法
22

33
欢迎阅读我们的文档!本文档将指导您了解如何有效地使用我们的文档以便快速上手。
4-
## 导航和跳转
54

6-
本文档的目录结构清晰,您可以在左侧目录栏查看所有可用的章节和小节。点击相应的章节或小节标题,即可快速跳转到您想要查看的内容。例如,如果您想了解YAML插件的参数类型与函数,可以直接点击“附录”下的
7-
- [**YAML插件的参数类型与函数**](/guide/yaml/yaml_type_func.md)
5+
## 初学者
6+
7+
1. 请先访问[快速开始](/guide/QuickStart.md),尝试编写您的第一个插件,并尝试运行起来吧,有的时候,你得先学会跑步,才能学会走路。
8+
2. 成功后,可以查看YAML插件介绍相关的内容,去了解插件的细节,在这个过程中,可以使用[规则实验室](https://poc.xray.cool)作为辅助理解,了解http请求与poc字段间的关系
9+
10+
## 进阶
11+
12+
当学会了基本的插件编写规则后,开始自己编写POC了,推荐先去看看[POC编写示例](/guide/course/phaseIII.md),其中完整的讲解了怎么从一个漏洞情报到高质量漏洞的全过程
13+
然后根据自己想要编写的漏洞的类型,在侧边栏里找到对应的类型,并查看详细的编写教程,比如SQL注入,就跳转到[SQL Injection(SQL注入)](/guide/hiq/sql_injection.md)
814

915
## 代码示例
1016

1117
本文档包含许多代码示例,以帮助您更好地理解各种功能和用法。您可以直接复制这些代码示例,然后在您的环境中运行,以便更好地理解这些示例。
1218
- [**POC编写模板**](/guide/yaml/yaml_poc_template.md)
13-
- [**指纹编写模板**](/guide/yaml/yaml_finger_template.md)
1419

1520
## 类型与函数
1621

0 commit comments

Comments
 (0)