docs/mkdocs.yml at master · 51nk0r5w1m/docs · GitHub

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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# pip install mkdocs mkdocs-material
# mkdocs serve
# mkdocs gh-deploy

site_name: OWASP Amass Project
site_url: https://owasp-amass.github.io/docs/
repo_name: OWASP Amass
repo_url: https://github.com/owasp-amass/amass
site_description: "In-depth OSINT collection and external attack surface mapping"
site_author: OWASP Amass Contributors
remote_branch: gh-pages

#copyright: 2025 Jeff Foley

theme:
  name: 'material'
  favicon: assets/favicon.png
  icon:
    logo: simple/owasp
    annotation: material/plus-circle
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: 'black'
      accent: 'blue'
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: 'black'
      accent: 'blue'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: 'Lato'
    code: 'Fira Code'
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - navigation.tracking
    - toc.follow


extra_css:
  - stylesheets/extra.css


# Additional configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/owasp-amass
    - icon: fontawesome/brands/docker
      link: https://github.com/owasp-amass/amass-docker-compose
    - icon: fontawesome/brands/discord
      link: https://discord.gg/HNePVyX3cp
    - icon: fontawesome/brands/mastodon
      link: https://infosec.exchange/@amass
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/owaspamass/


# Python Markdown
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - tables

# Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Mermaid Chart Config
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format


# Page tree
nav:
  - Getting Started: index.md
  - Configuration:
    - Configuration: configuration/index.md
    - Data Sources: configuration/data_sources.md
    - Transformations: configuration/transformations.md
  - Asset Database:
    - Asset Database: asset_db/index.md
    - PostgreSQL: asset_db/postgres.md
    - Triples: asset_db/triples.md
  - Open Asset Model:
    - Open Asset Model: open_asset_model/index.md
    - Assets:
      - Assets: open_asset_model/assets/index.md
      - Account: open_asset_model/assets/account.md
      - AutnumRecord: open_asset_model/assets/autnum_record.md
      - AutonomousSystem: open_asset_model/assets/autonomous_system.md
      - ContactRecord: open_asset_model/assets/contact_record.md
      - DomainRecord: open_asset_model/assets/domain_record.md
      - File: open_asset_model/assets/file.md
      - FQDN: open_asset_model/assets/fqdn.md
      - FundsTransfer: open_asset_model/assets/funds_transfer.md
      - Identifier: open_asset_model/assets/identifier.md
      - IPAddress: open_asset_model/assets/ip_address.md
      - IPNetRecord: open_asset_model/assets/ipnet_record.md
      - Location: open_asset_model/assets/location.md
      - Netblock: open_asset_model/assets/netblock.md
      - Organization: open_asset_model/assets/organization.md
      - Person: open_asset_model/assets/person.md
      - Phone: open_asset_model/assets/phone.md
      - Product: open_asset_model/assets/product.md
      - ProductRelease: open_asset_model/assets/product_release.md
      - Service: open_asset_model/assets/service.md
      - TLSCertificate: open_asset_model/assets/tls_certificate.md
      - URL: open_asset_model/assets/url.md
    - Relations:
      - Relations: open_asset_model/relations/index.md
      - BasicDNSRelation: open_asset_model/relations/basic_dns_relation.md
      - PortRelation: open_asset_model/relations/port_relation.md
      - PrefDNSRelation: open_asset_model/relations/pref_dns_relation.md
      - SimpleRelation: open_asset_model/relations/simple_relation.md
      - SRVDNSRelation: open_asset_model/relations/srv_dns_relation.md
    - Properties:
      - Properties: open_asset_model/properties/index.md
      - DNSRecordProperty: open_asset_model/properties/dns_property.md
      - SimpleProperty: open_asset_model/properties/simple_property.md
      - SourceProperty: open_asset_model/properties/source_property.md
      - VulnProperty: open_asset_model/properties/vuln_property.md
  - Contributing: contributing/contributing.md