zizmor/mkdocs.yml at main · Stars1233/zizmor · 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
strict: true
site_name: "zizmor"
site_description: Static analysis for GitHub Actions
site_url: https://docs.zizmor.sh/
docs_dir: docs
site_dir: site_html
dev_addr: "127.0.0.1:9999"
repo_url: https://github.com/zizmorcore/zizmor
edit_uri: edit/main/docs

nav:
  - Welcome: "index.md"
  - "installation.md"
  - "quickstart.md"
  - "usage.md"
  - "integrations.md"
  - "troubleshooting.md"
  - "release-notes.md"
  - "configuration.md"
  - "audits.md"
  - "development.md"
  - "trophy-case.md"

plugins:
  - search
  - social

theme:
  name: material
  logo: assets/rainbow.svg
  favicon: assets/favicon48x48.png
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    annotation: material/arrow-right-circle
    repo: fontawesome/brands/github
  features:
    - navigation.expand
    - navigation.footer
    - navigation.sections
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  # Makes sure we render `<https://...>`-style links correctly.
  - pymdownx.magiclink:
      repo_url_shorthand: true
      normalize_issue_symbols: true
      provider: github
      user: zizmorcore
      repo: zizmor
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.snippets:
      base_path:
        - "docs/snippets"
      check_paths: true
      auto_append:
        - abbreviations.md
  - md_in_html
  - abbr
  - attr_list
  - toc:
      permalink: 🔗
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra_css:
  - assets/magiclink.css
  - assets/chips.css

exclude_docs: |
  snippets/

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/zizmorcore/zizmor
      name: "zizmorcore/zizmor on GitHub"
    - icon: fontawesome/brands/mastodon
      link: https://infosec.exchange/@yossarian
      name: "@yossarian@infosec.exchange on Mastodon"
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/yossarian.net
      name: "@yossarian.net on Bluesky"
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/PGU3zGZuGG
      name: "Join the Zizmor Discord"
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/zizmor/
      name: "Zizmor on PyPI"
    - icon: fontawesome/brands/rust
      link: https://crates.io/crates/zizmor
      name: "Zizmor on crates.io"

copyright: "&copy; 2024 William Woodruff"