AdvancedNLPClasses/mkdocs.yml at main · agombert/AdvancedNLPClasses · 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
site_name: "Advanced NLP Classes"
nav:
  - Classes:
    - Overview: index.md
    - "Session 1: Introduction to the class": chapter1/README.md
    - "Session 2: Deep Learning for NLP": chapter2/README.md
    - "Session 3: Word Embeddings": chapter3/README.md
    - "Session 4: Practical NLP - 1": chapter4/README.md
    - "Session 5: Transformers & BERT": chapter5/README.md
    - "Session 6: Few-Shot learning & Transfer Learning": chapter6/README.md
    - "Session 7: Injustice & Biases in NLP": chapter7/README.md
    - "Session 8: Practical NLP - 2": chapter8/README.md
    - "Session 9: LLM introduction": chapter9/README.md
    - "Session 10: Agents": chapter10/README.md
  - Notebooks: notebooks.md
  - Resources: resources.md
  - Evaluations:
    - Overview: evaluations/evaluations.md
    - "First Home Assignment": evaluations/first-home-assignment.md
    - "Second Home Assignment": evaluations/second-home-assignment.md
    - "Final Project": evaluations/final-project.md

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

# Add repository URL to show GitHub link at the top
repo_url: https://github.com/agombert/AdvancedNLPClasses
repo_name: agombert/AdvancedNLPClasses

plugins:
  - search
  - mkdocs-jupyter:
      execute: false
      include_source: true

# Configuration for static files (PDFs)
use_directory_urls: true

# Use 'extra' to copy additional files (instead of 'extra_files')
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/agombert/AdvancedNLPClasses

# Add this to handle static files like PDFs
docs_dir: docs

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

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