forked from PrairieLearn/PrairieLearn
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
98 lines (89 loc) · 3.42 KB
/
mkdocs.yml
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
site_name: PrairieLearn
site_url: https://github.com/PrairieLearn/PrairieLearn
repo_url: https://github.com/PrairieLearn/PrairieLearn
theme: readthedocs
docs_dir: docs
# Fix "Edit on GitHub" link: (defaults to edit/master/docs/, note the s)
edit_uri: blob/master/docs/
markdown_extensions:
# Allows us to use 2-space indents on lists, which is compatible with how
# Prettier formats Markdown files.
# https://pypi.org/project/mdx-truly-sane-lists/
- mdx_truly_sane_lists
# allows indented code blocks inside lists
- pymdownx.superfences
- toc:
permalink: true
# Allows note/warning boxes
- admonition
extra_javascript:
- mathjax-config.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js
extra_css:
- extra.css
nav:
- Main: 'index.md'
- Getting Started:
- 'Requesting your course space': 'requestCourse.md'
- 'Creating content in the browser': 'getStarted.md'
- 'Workshop': 'workshop/index.md'
- Student Guide:
- 'Accessibility': 'student-guide/accessibility.md'
- Instructor Guide:
- 'Installing and running locally': 'installing.md'
- 'Editing and syncing course content': 'sync.md'
- 'Course configuration': 'course.md'
- 'Course instance configuration': 'courseInstance.md'
- 'Assessment configuration': 'assessment.md'
- 'Question configuration': 'question.md'
- 'Question runtime environment': 'questionRuntime/index.md'
- 'Elements for writing questions': 'elements.md'
- 'Access control': 'accessControl.md'
- 'Remote exams': 'remoteExams.md'
- 'clientFiles and serverFiles': 'clientServerFiles.md'
- 'UUIDs in JSON files': 'uuid.md'
- 'Regrading assessments': 'regrading.md'
- 'Element for drawing': 'pl-drawing/index.md'
- 'External grading': 'externalGrading.md'
- 'Python autograder': 'python-grader/index.md'
- 'C/C++ autograder': 'c-grader/index.md'
- 'Java autograder': 'java-grader/index.md'
- 'Workspaces': 'workspaces/index.md'
- 'Manual grading': 'manualGrading/index.md'
- 'Question sharing': 'questionSharing.md'
- 'What to tell students': 'whatToTellStudents.md'
- 'FAQ': 'faq.md'
- 'API': 'api.md'
- Developer Guide:
- 'Developer guide': 'dev-guide.md'
- 'Running in Docker with local source': 'installingLocal.md'
- 'Running natively': 'installingNative.md'
- 'Server configuration': 'configJson.md'
- 'Question element writing': 'devElements.md'
- 'Element extensions': 'elementExtensions.md'
- 'Code execution': 'codeExecution.md'
- 'Docker packaging': 'docker.md'
- 'Contributing to PL development': 'contributing.md'
- Administrators:
- 'SAML SSO configuration': 'saml.md'
- 'LTI 1.3 configuration': 'lti13.md'
- Running in Production:
- 'Setup': 'running-in-production/setup.md'
- 'Using Docker Compose': 'running-in-production/docker-compose.md'
- 'User Authentication': 'running-in-production/authentication.md'
- 'Admin User': 'running-in-production/admin-user.md'
- Deprecated Features:
- 'Old v1/v2 question format': 'oldQuestion.md'
- 'Old PrairieDraw graphics': 'PrairieDraw.md'
not_in_nav: |
workshop/lesson1.md
workshop/lesson2.md
workshop/lesson3.md
workshop/lesson4.md
workshop/lesson5.md
python-grader/sphinx-docs.md
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn