3dcdsc.github.io/mkdocs.yml at master · 3DCdsc/3dcdsc.github.io · 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
site_name: Digital Design and Development Club (3DC)
site_url: https://3dc.opensutd.org/
docs_dir: docs/

# repo_name: '3DCdsc/3dcdsc.github.io'
# repo_url: 'https://github.com/3DCdsc/3dcdsc.github.io'

# 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:
    - Home: "index.md"
    #     - Projects:
    #         - Projects: 'project.md'
    - Workshops:
          - 2021:
                - Intro to Programming: "Workshops/2021/intro_to_programming.md"
                - Blockchain Development: "Workshops/2021/blockchain_dev_workshop.md"
          - 2020: "Workshops/2020/past_workshops.md"
          - Workshop Organizer Guide: "Workshops/workshop_guide.md"
    - Events:
          - Google Tech Challenge 2021:
                - Introduction: "gtc.md"
                - "Web: Cookerino Website":
                      - "Day 1: Back-end (Django) Development": "gtc/web/day1.md"
                      - "Day 2: Front-end (React) Development": "gtc/web/day2.md"
                - Android:
                      - Introduction: "gtc/android/android.md"
                      - Day 0 - Environment Setup: "gtc/android/day0a.md"
                      - Day 0 - Java Tutorial: "gtc/android/day0b.md"
                      - Day 1.1 - Introduction to Android Studio: "gtc/android/day1_androidstudio.md"
                      - Day 1.2 - Introduction to GUI: "gtc/android/day1_gui.md"
                      - Day 1.3 - Java in Android: "gtc/android/day1_java.md"
                      - Day 2.1 - Firebase Introduction: "gtc/android/day2-firebase-intro.md"
                      - Day 2.2 - Adding Firebase to Your Project: "gtc/android/day2-firebase-sdk.md"
                      - Day 2.3 - Adding Firebase Auth: "gtc/android/day2-firebase-auth.md"
                      - Day 2.4 - Adding Firebase Realtime Database: "gtc/android/day2-firebase-db.md"
                      - Day 2.5 - Adding Firebase Storage: "gtc/android/day2-firebase-storage.md"
                      - Day 2.6 - (Bonus) Feeding your Friend's Pets: "gtc/android/day2-bonus.md"
                      - Day 2.7 - Distributing your App: "gtc/android/day2-distribute.md"
                      - Wrapup: "gtc/android/wrapup.md"
                - Cloud:
                      - Session 1: "gtc/cloud/cloud.md"
                - Telegram Bot:
                      - Day 1: "gtc/telebot/day1.md"
                      - Day 2: "gtc/telebot/day2.md"
          - Recess Week Challenge 2020:
                - Challenge Introduction: "Recess_Week_Challenge_Stuff/recess_week_challenge.md"
                - Cloud-based Lab: "Recess_Week_Challenge_Stuff/cloud_based_lab.md"
                - HackerRank Guide: "Recess_Week_Challenge_Stuff/guide.md"
                - Teaser Hints: "Recess_Week_Challenge_Stuff/teaser_hints.md"
                - Teaser Solution: "Recess_Week_Challenge_Stuff/teaser_sols.md"
                - Q1 Hints: "Recess_Week_Challenge_Stuff/q1_hints.md"
                - Q1 Solution: "Recess_Week_Challenge_Stuff/q1_sol.md"
                - Q2 Solution: "Recess_Week_Challenge_Stuff/q2_sol.md"
                - Q3 Hints: "Recess_Week_Challenge_Stuff/q3_hints.md"
                - Q3 Solution: "Recess_Week_Challenge_Stuff/q3_sol.md"
                - Q4 Solution: "Recess_Week_Challenge_Stuff/q4_sol.md"
                - Q5 Hints: "Recess_Week_Challenge_Stuff/q5_hints.md"
    - About Us:
          - Core Team: "core_team.md"
          - Contact Us: "contact_us.md"
          - Code of Conduct: "code_of_conduct.md"
          - Join Us:
                - Join 3DC as a Member: "3dc_membership.md"
                - Join 3DC Core Team: "join_3dc_core.md"