Introduction_to_Programming/mkdocs.yml at main · 3DCdsc/Introduction_to_Programming · 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
site_name: Introduction to Programming
site_url: http://3dc.opensutd.org/Introduction_to_Programming
docs_dir: docs/

repo_name: "Introduction_to_Programming"
repo_url: "https://github.com/3DCdsc/Introduction_to_Programming"

# Copyright
copyright: Digital Design and Development Club (3DC) &copy; 2019 - 2021. All rights reserved.

# Theme Configuration
theme:
  name: material
  language: en
  favicon: imgs/code.svg
  icon:
    logo: fontawesome/solid/code
  features:
    # - navigation.tabs
    - navigation.expand
  palette:
    scheme: slate
    primary: teal
    accent: indigo

# Extensions
# https://squidfunk.github.io/mkdocs-material/reference/abbreviations/
markdown_extensions:
  - attr_list # https://squidfunk.github.io/mkdocs-material/reference/buttons/#attribute-list
  - admonition # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition
  - pymdownx.caret # handling sub- and superscripts
  - pymdownx.mark # highlighting of text
  - pymdownx.tilde # strikethrough of text
  - pymdownx.keys # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#keys
  - pymdownx.tabbed # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#tabbed
  - pymdownx.details # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#details
  - pymdownx.highlight # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-blocks
  - pymdownx.superfences # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#superfences
  - pymdownx.smartsymbols # supporting special characters like copyright symbol (c)
  - pymdownx.arithmatex: # https://squidfunk.github.io/mkdocs-material/reference/mathjax/#arithmatex
      generic: true
  - pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#emoji
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist: # https://squidfunk.github.io/mkdocs-material/reference/lists/#tasklist
      custom_checkbox: true
      clickable_checkbox: true
  - toc: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#table-of-contents
      permalink: true

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

extra_css:
  - stylesheets/extra.css

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/3DCdsc
    - icon: fontawesome/brands/twitch
      link: https://www.twitch.tv/3dcdsc
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCF56lQD1HWv-0uOQSXrTmLw
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/sutd3dc/
    - icon: fontawesome/brands/telegram
      link: https://t.me/joinchat/C_Nni1C77ZlOVTdjU4yf4Q

# Navigation Menu
nav:
  - Overview: "index.md"
  - Workshop Materials:
      - Day 0:
          - Setup Environment: "Day_0/setup_guides.md"
          - Install Git: "Day_0/install_git.md"
          - Install Python:
              - on macOS: "Day_0/install_python_mac.md"
              - on Windows: "Day_0/install_python_win.md"
      - Day 1:
          - Python Basics: "Day_1/python_basics.md"
      - Day 2:
          - Git:
            - Overview: "Day_2/git_overview.md"
            - Data Model: "Day_2/git_data_model.md"
            - Key Concepts (Local): "Day_2/git_local_concepts.md"
            - Key Concepts (Remote): "Day_2/git_remote_concepts.md"
            - Example: "Day_2/git_example.md"
          - Python OOP: "Day_2/python oop.md"
      - Day 3:
          - Web Basics: "Day_3/web_basics.md"
      - Day 4:
          - Server Basics: "Day_4/server_basics.md"
      - Day 5:
          - Intro to Linux: "Day_5/intro_to_linux.md"