notes/mkdocs.yml at main · patrick-5546/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
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
# Project information
site_name: Patrick's Notes
site_url: https://patrick-5546.github.io/notes/
site_author: Patrick Creighton

# Repository
repo_name: patrick-5546/notes
repo_url: https://github.com/patrick-5546/notes
edit_uri: ""

# Configuration
theme:
  name: material
  features:
    - content.code.annotate
    - navigation.expand
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      timezone: America/Vancouver
  - social

# Customization
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: material/github
      link: https://github.com/patrick-5546
    - icon: material/linkedin
      link: https://www.linkedin.com/in/patrick-5546/
    - icon: material/email
      link: mailto:pcreighton429@gmail.com

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Page tree
nav:
  - Home: index.md
  - Setup:
    - setup/index.md
    - CLI:
      - Common: setup/cli/common-cli.md
      - Unix: setup/cli/unix-cli.md
      - Windows: setup/cli/windows-cli.md
    - Terminal:
      - Unix: setup/terminals/unix-terminal.md
      - Windows: setup/terminals/windows-terminal.md
    - IDE: setup/ide.md
    - GUI:
      - Windows: setup/gui/windows-gui.md
  - Internship Preparation:
    - internship_prep/index.md  # disclaimer: not a learning resource, but for brush up / review / knowledge check
    - Applications: internship_prep/applications.md
    - Interview Preparation: internship_prep/interview_prep.md
    - Hardware Interviews:
      - Reference: internship_prep/hardware/hw_reference.md  # definitions list for each topic, use abbreviations
      - Questions: internship_prep/hardware/hw_questions.md
    - Software Interviews:
      - Reference: internship_prep/software/sw_reference.md
      - Questions: internship_prep/software/sw_questions.md
  - Reference:
    - Bookmarks: reference/bookmarks.md
    - Git:
      - Contribution Process: reference/git/git_contributing.md
      - Commands: reference/git/git_commands.md
      - Advanced Features: reference/git/git_advanced.md
    - Unix Commands: reference/unix.md
    - Material for MkDocs: reference/mkdocs.md
    - Python: reference/python.md
    - SSH: reference/ssh.md
    - Windows Shortcuts: reference/shortcuts.md
    - WSL: reference/wsl.md
  - About Me: profile.md