introllms/mkdocs.yml at main · ua-data7/introllms · 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
131
132
site_name: 'GPT 101'
site_description: 'Documentation for Prompt Engineering 101 Workshop'
site_author: 'University of Arizona Data Sciences Institute'
site_url: https://ua-data7.github.io/introllms

# Repository
repo_name: introllms
repo_url: https://github.com/ua-data7/introllms
edit_uri: edit/main/docs/
# Copyright
copyright: 'Copyright &copy; 2023 University of Arizona Data Science Institute'

# Page tree
nav:
  - Home: index.md
  - Workshop Agenda: agenda.md
  - Getting Started:
    - ChatGPT: chatgpt.md
    - Bing: bing.md
    - Bard: bard.md
  - Prompt Engineering:
    - Basic Prompt Enginering: chatgpt_prompts.md
    - Daily Productivity: daily-productivity.md
  - Education:
    - Teaching & Mentoring: education.md
  - Plugins:
    - Plugins: plugins.md
  - Research:
    - AI Landscape: ai_landscape.md
    - Coding with CoPilot: github_copilot.md
    - OpenAI extensions: openai_extensions.md
    - HuggingFace:
      - Models: huggingface_models.md
      - Datasets: huggingface_datasets.md
      - Gradio: huggingface_gradio.md
  - Ethics:
    - Ethics: ethics.md
# Configuration
imgwidth: 70px;
theme:
  highlightjs: true
  name: material
  font:
    text: 'Open Sans'
    code: 'Roboto Mono'
  logo: 'assets/uarizona.png'
  favicon: 'assets/favicon.ico'
# setting features for the navigation tab
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - toc.integrate
    - toc.follow
    - content.code.copy
  # Default values, taken from mkdocs_theme.yml
  language: en
  # custom_dir: 'overrides'
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: white)"
      primary: 'white'
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference

# Options
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ua-data7/

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - 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.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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

extra_css:
  - stylesheets/extra.css

plugins:
    - search
    - mkdocstrings
    - git-revision-date
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True