-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
102 lines (97 loc) · 3.7 KB
/
Copy pathmkdocs.yml
File metadata and controls
102 lines (97 loc) · 3.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: Faction 2 Documentation
site_url: https://docs.factionsecurity.com/
site_description: OWASP Faction is open source penetration testing management software. Automate pentest reporting from DOCX templates, write findings with AI, manage pentest teams, and track vulnerability remediation with SLAs.
docs_dir: docs
use_directory_urls: true
theme:
name: material
custom_dir: overrides
logo: assets/images/faction-logo.png
favicon: assets/images/favicon.png
# Same look as the original docs portal: dark (slate) scheme with a white header.
palette:
scheme: slate
primary: white
features:
- content.code.copy
# Top-level nav sections become tabs across the header; the left sidebar
# then only lists the pages of the active tab.
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
- navigation.indexes
- navigation.expand
- navigation.top
- toc.follow
repo_url: https://github.com/factionsecurity/OWASP-Faction-2
nav:
- Home: index.md
- Getting Started:
- getting-started/index.md
- Running OWASP Faction: getting-started/install.md
- 1. Schedule an assessment: getting-started/schedule-assessment.md
- 2. Add findings and generate the report: getting-started/first-report.md
- Bulk-import assessments from a CSV: getting-started/import-assessments-csv.md
- Permissions:
- Overview: permissions/index.md
- Scopes: permissions/scopes.md
- What is enforced: permissions/enforcement.md
- Built-in roles: permissions/roles.md
- Permission reference: permissions/reference.md
- Reporting:
- reporting/index.md
- Using DOCX Report Templates: reporting/docx-templates.md
- Retest Reports: reporting/retest-reports.md
- Code Block Themes: reporting/code-block-themes.md
- User Defined Fields: reporting/user-defined-fields.md
- Assessment Checklists: reporting/checklists.md
- Templating:
- templating/index.md
- Content Templates: templating/content-templates.md
- AI Content Generation: templating/ai-content.md
- AI Configuration: templating/ai-configuration.md
- Solutions:
- solutions/index.md
- Automate Pentest Reporting: solutions/automate-pentest-reporting.md
- Write Pentest Reports with AI: solutions/ai-pentest-report-writing.md
- Manage Large Pentest Teams: solutions/managing-pentest-teams.md
- Track Vulnerabilities and SLAs: solutions/vulnerability-management-sla.md
- Integrations:
- MCP Server: integrations/mcp-server.md
# The Faction 1.x documentation is a separate MkDocs site in faction1.x/, built into
# site/faction1.x/ by `mise run build` and served under this path.
- Faction 1.x Docs: /faction1.x/
markdown_extensions:
- admonition
- attr_list
- def_list
# Required for Material's "grid cards" blocks — without it the markdown inside a
# <div markdown> is emitted verbatim.
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
extra:
generator: false
analytics:
provider: google
property: G-LQPM8RS39Z
social:
- icon: fontawesome/brands/mastodon
link: https://infosec.exchange/@null0perat0r
- icon: fontawesome/brands/bluesky
link: https://bsky.app/profile/factionsecurity.com
- icon: fontawesome/brands/github
link: https://github.com/factionsecurity/faction2
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@factionsecurity
- icon: fontawesome/brands/tiktok
link: https://www.tiktok.com/@factionsecurity
- icon: simple/substack
link: https://substack.com/@factionsecurity
extra_css:
- assets/css/extra.css