vedantmadane.github.io/mkdocs.yml at master · VedantMadane/vedantmadane.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
# Project information
site_name: Minimal Workshop
site_url: https://vedantmadane.github.io/minimal-workshop-mkdocs
site_author: IBM Developer

# Repository
repo_name: minimal-workshop-mkdocs
repo_url: https://github.com/vedantmadane/minimal-workshop-mkdocs
# Change the middle parameter to the default branch, "master" or "main"
edit_uri: edit/master/docs

# Navigation
nav:
  - Welcome:
    - About the workshop: index.md
    - Compatability: welcome/compatability.md
    - Authors: welcome/authors.md
  - Get started:
    - Prerequisites: get-started/prereqs.md
    - The environment: get-started/environment.md
    - About the data set: get-started/data-set.md
    - Feedback survey: get-started/survey.md
  - Workshop:
    - Lab 1: workshop/lab-1.md
    - Lab 2: workshop/lab-2.md
    - Lab 3: workshop/lab-3.md
  - Reference:
    - Additional resources: reference/resources.md
    - Admin guide: reference/admin-guide.md
    - Mkdocs examples: reference/mkdocs.md
  - Changelog:
    - Release notes: changelog.md

## DO NOT CHANGE BELOW THIS LINE

# Copyright
copyright: Copyright &copy; 2020 IBM Developer

# Theme
theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  # Choose between specifying a file with "logo"
  # or using a built-in one with "icon"
  #logo: assets/bee.png
  icon:
    logo: material/library
  features:
    #- navigation.tabs
    - navigation.instant
    - navigation.expand
  palette:
    scheme: default
    primary: blue
    accent: blue

# Plugins
plugins:
  - search

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ibm
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ibmdeveloper
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ibm/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/user/developerworks
    - icon: fontawesome/brands/dev
      link: https://dev.to/ibmdeveloper
  version:
    provider: mike

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - 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.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde