Wiki/mkdocs.yml at main · BruceDevices/Wiki · 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
site_name: Bruce Wiki
site_url: https://wiki.bruce.computer
site_description: Documentation for Bruce - a versatile ESP32 firmware for red team operations, featuring WiFi attacks, RF analysis, RFID tools, and more on M5Stack, Lilygo and many other devices.
repo_url: https://github.com/BruceDevices/firmware
repo_name: GitHub
edit_uri: https://github.com/BruceDevices/Wiki/blob/main/docs/

docs_dir: docs
site_dir: site
use_directory_urls: true

extra_css:
  - assets/stylesheets/extra.css

theme:
  name: material
  palette:
    # Dark mode (default)
    - scheme: slate
      primary: bruce
      accent: bruce
      toggle:
        icon: material/weather-sunny
        name: Light

    # Light mode
    - scheme: default
      primary: bruce
      accent: bruce
      toggle:
        icon: material/weather-night
        name: Dark

  logo: assets/images/logo.png
  favicon: assets/images/favicon.png
  features:
    - content.code.copy
    - content.code.select
    - content.action.edit
    - content.action.view
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - XXXnavigation.tabs
    - XXXnavigation.sections
    - XXXnavigation.expand
    - navigation.path
    - XXXnavigation.indexes

extra:
  generator: false
  homepage: https://bruce.computer

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - toc:
      permalink: "#"
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - md_in_html
  - pymdownx.blocks.caption

plugins:
  - search
  - social:
      enabled: !ENV [CI, false]
      cards_layout_dir: layouts
      cards_layout: bruce
      debug: false
  # - tags:
  #     shadow_tags_suffix: Internal
  #     shadow: false
  #     shadow_on_serve: true
  #     shadow_tags:
  #       - Draft
  #       - Internal
  #       - TODO
  - git-revision-date-localized:
      enabled: !ENV [CI, false]
  - awesome-pages
  - glightbox