git-cheats/mkdocs.yml at main · rbcmgs/git-cheats · 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
140
141
142
143
site_name: Git Cheats
site_description: A personal Git reference guide
site_author: Robert Cummings
site_url: https://git-cheats.cmgs.io
repo_name: rbcmgs/git-cheats
repo_url: https://github.com/rbcmgs/git-cheats
edit_uri_template: 'blob/main/docs/{path}'

theme:
  name: material
  language: en
  palette:

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: Open Sans
    code: JetBrains Mono
  icon:
    logo: material/git
    repo: fontawesome/brands/github
  features:
    - navigation.top
    - navigation.expand
    - navigation.sections
    - navigation.instant
    - navigation.instant.progress
    - navigation.indexes
    - navigation.tracking
    - navigation.footer
    - navigation.search.highlight
    - navigation.search.share
    - navigation.search.suggest
    - navigation.search.suggest.auto
    - navigation.search.suggest.delay: 300ms
    - navigation.search.suggest.min_length: 2
    - navigation.search.suggest.max_results: 10
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips

markdown_extensions:
  - attr_list
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.emoji
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid2
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - tags
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
  - mermaid2:
      arguments:
        securityLevel: 'loose'
        theme: base

extra:
  analytics:
    provider: google
    property: G-MEASUREMENT_ID  # Replace with your actual Google Analytics ID when needed

extra_css:
  - stylesheets/custom.css

extra_javascript:
  - scripts/load-mermaid.js

nav:
  - Quick Reference: index.md
  - Introduction: git-introduction.md
  - Setup and Init: setup-and-init.md
  - Basic Usage: basic-usage.md
  - Branching: branching.md
  - Merging & Rebasing: merging-rebasing.md
  - Remote Operations: remote-operations.md
  - Stash & Clean: stash-clean.md
  - Tags & Releases: tags-releases.md
  - Logs, Diffs & History: logs-diffs-history.md
  - Config & Aliases: config-aliases.md
  - Troubleshooting: troubleshooting.md
  - Advanced Topics: advanced-topics.md
  - Development Workflows: development-workflows.md
  - GitHub Actions: github-actions.md
  - Other Resources: resources.md

copyright: Copyright &copy; 2025 Robert B. Cummings. All rights reserved.