CarkHT.github.io/mkdocs.yml at main · CarkHT/CarkHT.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
# Project information
site_name: Lambda Feedback Documentation
site_author: Pierre Tharreau, Louis Manestar
site_url: https://lambda-feedback.github.io/user-documentation/
site_description: >-
  Architecture, syntax and usage details for an online learning platform
  focused on providing rich feedback to the user.
repo_url: https://github.com/lambda-feedback/user-documentation
edit_uri: blob/main/docs/

# Project tree
nav:
  - Home:
      - "index.md"
      - Publications: "publications.md"
      - Opportunities: "opportunities.md"
      - Terminology: "terminology.md"
      - Releases:
          - Major releases: "releases/major_releases.md"
          - Detailed Releases: "releases/detailed_releases.md"
          - Previous releases:
              - 2023-24: "releases/relases_2023_24.md"
          - Status: "releases/status.md"

  - Students:
      - "student/index.md"
      - Getting Started: "student/getting_started_student.md"
      - Answering Questions: "student/answering_questions.md"
      - Response Areas: "student/response_areas.md"
      - Text Editing: "student/lexdown_student.md"
      - FAQ: "student/faq.md"

  - Teachers:
      - "teacher/index.md"
      - Guides:
          - Getting Started: "teacher/guides/gettingstarted.md"
          - Editing questions: "teacher/guides/content-sets-questions.md"
          - Exporting and importing questions: "teacher/guides/question-export-import.md"
          - Milkdown: "teacher/guides/lexdown.md"
          - Analytics: "teacher/guides/analytics.md"
          - Good practice: "teacher/guides/good-practice.md"
          - FAQ: "teacher/guides/faq.md"
          - Guidance:
              - Guidance Time Suggestion: "teacher/guides/guidance/guidance-time-suggestion.md"

      - Reference:
          - Access control: "teacher/reference/access_control.md"
          - Latex functionality: "teacher/reference/latex_functionality.md"
          - PDF generation: "teacher/reference/pdf_generation.md"
          - Response Areas:
              - "teacher/reference/response_area_components/index.md"
              - Text: "teacher/reference/response_area_components/Text.md"
              - Number: "teacher/reference/response_area_components/Number.md"
              - Boolean: "teacher/reference/response_area_components/Boolean.md"
              - NumericUnits: "teacher/reference/response_area_components/NumericUnits.md"
              - Expression: "teacher/reference/response_area_components/Expression.md"
              - MultipleChoice: "teacher/reference/response_area_components/MultipleChoice.md"
              - Matrix: "teacher/reference/response_area_components/Matrix.md"
              - Table: "teacher/reference/response_area_components/Table.md"
          - Evaluation Functions:
              - "teacher/reference/evaluation_functions/index.md"

  - Advanced:
      - "advanced/index.md"
      - Response Areas:
          - Overview: "advanced/response_areas/overview.md"
      - Evaluation Functions:
          - Quickstart Guide: "advanced/evaluation_functions/quickstart.md"
          - General Specification: "advanced/evaluation_functions/specification.md"
          - Feedback: "advanced/evaluation_functions/feedback.md"
          - Testing Functions Locally: "advanced/evaluation_functions/local.md"
          - Evaluation Function Utils: "advanced/evaluation_functions/module.md"
          - Deployed Functions:
              - "advanced/evaluation_functions/index.md"
          - Alternate Function Languages: "advanced/evaluation_functions/alternate_languages.md"
      - Chat functions:
          - Quickstart: "advanced/chat_functions/quickstart.md"
          - Testing Functions Locally: "advanced/chat_functions/local.md"


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


# Extra variables, accessible within markdown pages
extra:
  urls:
    client: https://lambdafeedback.com