learning-notes/mkdocs.yml at main · Cyber-Syntax/learning-notes · 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
#===================================================================================#
# Site Information
#===================================================================================#
site_name: Cyber-Syntax Personal Notes
repo_name: Cyber-Syntax/learning-notes
repo_url: https://github.com/Cyber-Syntax/learning-notes
site_url: https://https://cyber-syntax.github.io/learning-notes
site_description: Cyber-Syntax Personal Notes
site_author: Cyber-Syntax
copyright: Copyright &copy; 2026 Cyber-Syntax.
edit_uri: edit/main/docs/

#===================================================================================#
# Mkdocs Theme (Material Mkdocs) + Extras
#===================================================================================#
theme:
    name: material
    # custom_dir: overrides
    language: en
    font: false
    icon:
        # https://www.materialpalette.com/icons
        logo: simple/knowledgebase
    favicon: assets/images/pp.jpg
    features:
        - content.action.edit
        - content.action.view
        - content.code.copy
        - content.code.select
        - content.code.annotate
    include_sidebar: true
    palette:
        # https://www.materialpalette.com/colors
        - primary: indigo
        - scheme: slate
          #primary: "teal" # comment to replace by /docs/assets/stylesheets
          accent: blue
          toggle:
              icon: material/toggle-switch-off-outline
              name: Switch to dark mode
        - scheme: slate
          #primary: "teal" # comment to replace by /docs/assets/stylesheets
          accent: teal
          toggle:
              icon: material/toggle-switch
              name: Switch to light mode

#===================================================================================#
# Mkdocs Markdown Extentions, Plugins & extras
#===================================================================================#
markdown_extensions:
    - attr_list
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji ""
          emoji_generator: !!python/name:material.extensions.emoji.to_svg ""
    - pymdownx.highlight:
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences:
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format ""
plugins:
    - git-revision-date-localized:
          enable_creation_date: true
          type: datetime
          fallback_to_build_date: true
    - git-committers:
          repository: Cyber-Syntax/learning-notes
          branch: main
    - git-authors

extra_css:
    - assets/stylesheets/extra.css

#===================================================================================#
# Mkdocs Navigation Tree
#===================================================================================#
# nav:
#     - Home:
#           - Home: "index.md"
#           - Projects: "portfolio/projects.md"
#           - Education: "portfolio/education.md"
#           - Dev: "dev/index.md"