Skip to content

Configurations file

The current configuration file for this website is stored in a github repo and it contains the following:

  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
site_name: vNerd Docs
site_url: https://www.docs.vnerd.nl/
site_author: Karam Ajaj

repo_url: https://github.com/karam-ajaj/vnerd-docs
repo_name: karam-ajaj/vnerd-docs
# edit_uri: edit/master/docs/

# nav:
#   - Blog:
#     - blog/index.md

# nav:
#   - Home: '../'
#   - User Guide: 'hardware/hardware/index.md'
#   - Infrastructure Guide: 'Infrastructure/'

# Theme Configuration
theme:
  name: 'material'
  logo: assets/logos/vnerd-logo-white.png
  custom_dir: overrides
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    # - primary: black
    # - accent: indigo
    # primary: indigo
    # 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: default
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    # - navigation.sections
    # - navigation.expand
    # - navigation.prune
    - navigation.path
    - navigation.top
    # - navigation.indexes
    - header.autohide
    - toc.follow
    # - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    # - navigation.footer
    - content.code.copy
    - content.code.select
    - content.action.view
    # - content.action.edit
  # static_templates:
  #   - get
plugins:
  - blog:
      # blog_dir: blog
      # blog_toc: true
      # post_dir: blog/posts
      archive: false
  - search
  - external-markdown
  - awesome-pages
  #- mkdocs-blogging-plugin
  #- fontawesome-markdown
  # - projects
  # - optimize
  # - offline
  # - charts
  # - pdf-export
  # - print-site
  - termynal:
      title: bash
      buttons: macos
      prompt_literal_start:
        - "$"


  # https://github.com/squidfunk/mkdocs-material/discussions/3458
  # - redirects:
  #   redirect_maps:
  #     get: https://github.com/karam-ajaj/portainer-compose/blob/main/README.md


markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  # - pymdownx.snippets:
  #     auto_append:
  #       - includes/abbreviations.md
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences


extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/karam-ajaj/
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/karam.ajaj/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/karam-ajaj/
    # - icon: fontawesome/brands/slack
    #   link:
    - icon: fontawesome/brands/discord
      link: https://discordapp.com/users/1001115113245388831

extra_css:
  - stylesheets/extra.css

copyright: Copyright © Karam Ajaj