shieldcode/mkdocs.yml at main · nikolasdehor/shieldcode · 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
site_name: ShieldCode
site_description: Skill do Claude Code que protege código gerado contra OWASP Top 10. SQL injection, XSS, SSRF, path traversal e mais.
site_url: https://nikolasdehor.github.io/shieldcode/
site_author: Nikolas de Hor
repo_url: https://github.com/nikolasdehor/shieldcode
repo_name: nikolasdehor/shieldcode
edit_uri: edit/main/docs/

theme:
  name: material
  language: pt-BR
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Modo escuro
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Modo claro
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nikolasdehor
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/nikolasdehor
  generator: false

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: [".", "docs"]
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search:
      lang: pt
  - mermaid2
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
      timezone: America/Sao_Paulo
      locale: pt
      fallback_to_build_date: true

nav:
  - Início: index.md
  - Comece aqui:
      - Instalação: getting-started/install.md
      - Quickstart: getting-started/quickstart.md
      - Como a skill funciona: getting-started/how.md
  - Vulnerabilidades cobertas:
      - SQL Injection: vulns/sql-injection.md
      - XSS: vulns/xss.md
      - SSRF: vulns/ssrf.md
      - Path Traversal: vulns/path-traversal.md
  - Integração com frameworks:
      - Django: frameworks/django.md
      - FastAPI: frameworks/fastapi.md
      - Express / Node: frameworks/express.md
      - Spring Boot: frameworks/spring.md
  - Comparativo: comparison.md
  - Contribuir: contributing.md
  - Changelog: changelog.md