api/mkdocs.yml at master · vulnersCom/api · 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
site_name: Vulners Python SDK
site_description: Python SDK for the Vulners vulnerability intelligence API — typed sync & async clients.
site_url: https://vulnersCom.github.io/api/
repo_url: https://github.com/vulnersCom/api
repo_name: vulnersCom/api
copyright: Copyright &copy; Vulners

# `docs/` is reserved for local dev artifacts in this repo, so the public site
# source lives under `documentation/`.
docs_dir: documentation

# The per-family data-model pages (generated) are reached from the Data models
# index, not listed individually in the nav.
not_in_nav: |
  /reference/bulletins/base.md
  /reference/bulletins/*.md

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - toc.follow
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            filters: ["!^_"]
  # Emits `llms.txt` (a structured index) and `llms-full.txt` (full content) at
  # the site root, so LLM agents can consume the docs. `mike` multi-version
  # docs are deferred for now (single-version site).
  - llmstxt:
      markdown_description: >-
        The official Python SDK for the Vulners vulnerability intelligence API.
        Typed synchronous and asynchronous clients for searching CVEs, exploits
        and advisories, and auditing software, hosts and SBOMs.
      full_output: llms-full.txt
      sections:
        Getting started:
          - index.md
          - tutorials/quickstart.md
        How-to guides:
          - how-to/audit-a-host.md
          - how-to/stream-the-archive.md
          - how-to/search-exploits.md
          - how-to/proxy-timeout-retries.md
        Reference:
          - reference/clients.md
          - reference/resources.md
          - reference/models.md
          # reference/bulletins/*.md are deliberately NOT listed: the llmstxt plugin
          # rewrites a listed page's relative links to .md companions, but the
          # per-family data-model pages are not all listed (embedding every one would
          # bloat llms-full.txt), so a rewritten link would 404. The HTML site remains
          # the canonical data-model browser.
          - reference/exceptions.md
        Explanation:
          - explanation/network-and-rate-limits.md
          - explanation/search-window.md
          - explanation/error-model.md
          - explanation/migration.md

nav:
  - Home: index.md
  - Tutorials:
      - Quickstart: tutorials/quickstart.md
  - How-to guides:
      - Audit a host: how-to/audit-a-host.md
      - Stream the archive: how-to/stream-the-archive.md
      - Search exploits: how-to/search-exploits.md
      - Connect the MCP server: how-to/connect-mcp.md
      - Proxy, timeouts & retries: how-to/proxy-timeout-retries.md
  - Reference:
      - Clients: reference/clients.md
      - Resources: reference/resources.md
      - Models & pagination: reference/models.md
      - Data models: reference/bulletins/index.md
      - Exceptions: reference/exceptions.md
  - Explanation:
      - Network & rate limits: explanation/network-and-rate-limits.md
      - The 10,000-doc search window: explanation/search-window.md
      - Error model: explanation/error-model.md
      - Response shapes (untyped endpoints): explanation/response-shapes.md
      - Migrating v3 → v4: explanation/migration.md