GitTutorial/mkdocs.yml at main · Jacopo-DM/GitTutorial · 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
site_name: Basics of Git
repo_url: https://github.com/Jacopo-DM/GitTutorial
theme:
  favicon: assets/fav.svg
  logo: assets/logo.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.path
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - navigation.footer
    - navigation.indexes
  name: material
  language: en
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: red
      accent: blue
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

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

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

nav:
  - Welcome:
    - 'index.md'
    - About The Presenter: 'welcome/about_me.md'
    - Cheatsheet: 'welcome/cheatsheet.md'
  - Getting Started:
    - 'get_started/index.md'
    - 'Part 1: Installing Git': 'get_started/stage_1.md'
    - 'Part 2: Setting Up GitHub': 'get_started/stage_2.md'
    - 'Part 3: Our First Repo': 'get_started/stage_3.md'
    - 'Part 4: Cloning The Repository': 'get_started/stage_4.md'
    - 'Part 5: Our First Commit': 'get_started/stage_5.md'
    - 'Part 6: Deleting & Ignoring': 'get_started/stage_6.md'
    - 'Part 7: Remote Changes': 'get_started/stage_7.md'
  - Project:
    - 'project/index.md'
    - MNIST Classifier:
      - 'project/mnist/index.md'
    - Minecraft Clone:
      - 'project/minecraft/index.md'
    - Personal Website:
      - 'project/website/index.md'


markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: On this page
      toc_depth: 3


  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.critic

  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_css:
  - stylesheets/extra.css