-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
179 lines (172 loc) · 7.81 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
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
site_name: Canvas Collections
site_url: https://djplaner.github.io/canvas-collections/
repo_url: https://github.com/djplaner/canvas-collections
edit_uri: edit/main/docs/
site_author: David Jones
site_description: >-
Improve Canvas course site design by adding structure, visuals, context, and generativity to the Modules view
theme:
name: material
# logo: assets/squareLogo-cropped.png
logo: assets/collections-logo.jpg
palette:
- scheme: collections
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
custom_dir: .overrides
features:
- navigation.tabs
- navigation.instant
- navigation.footer
# - navigation.tracking
- navigation.tabs.sticky
- navigation.sections
- content.tabs.link
- header.autohide
- search.suggest
plugins:
- search
- social:
cards: !ENV [CARDS, false]
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- attr_list
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- def_list
- md_in_html
- tables
- pymdownx.tabbed:
alternate_style: true
# - pymdownx.tasklist:
# custom_checkbox: true
extra:
analytics:
provider: google
property: G-3J456JCJGP
social:
- icon: fontawesome/brands/mastodon
link: https://indieweb.social/@djplaner
- icon: fontawesome/brands/github
link: https://github.com/djplaner
nav:
- Home: index.md
- Get started: #getting-started.md
- How to start?: getting-started/how-to-start.md
- 1. Collections 101:
- Overview: getting-started/101/overview.md
- Concepts: getting-started/101/concepts.md
- Navigate: getting-started/101/interface/navigation.md
- Configure: getting-started/101/interface/configuration.md
# - Why, what, how?: getting-started/101/why-what-how.md
- 2. Install:
- Is it installed?: getting-started/install/is-it-installed.md
- How to install?: getting-started/install/how-to-install.md
- Individual: getting-started/install/individual.md
- Institutional: getting-started/install/institutional.md
- Configure:
- Configure Collections: configure/overview.md
- Before & after: configure/before-and-after.md
- Steps:
- 1. Design: configure/design.md
- 2. Configure collections: configure/configure-collections.md
- 3. Configure Modules: configure/configure-modules.md
- 4. Configure Representations: configure/configure-representations.md
- Claytons:
- Configure "Claytons": configure/set-up-claytons.md
- "Navigate":
- Navigation Options: navigate/navigate-options.md
- "Live Collections": navigate/navigating-live-collections.md
- "Claytons Collections": navigate/navigating-claytons-collections.md
# - Add Collections to a course:
# - Overview: how-tos/new/overview.md
# - Update Collections:
# - 🚧 Coming soon: how-tos/changes/overview.md
# - Add a collection: how-tos/changes/add-a-collection.md
# - Delete a collection: how-tos/changes/delete-a-collection.md
# - Add a module: how-tos/changes/add-a-module.md
# - Copy Collections:
# - 🚧 Course copy process: how-tos/course-copy/process.md
# - ⚗️ Advanced:
# - Multi-collection, one page Claytons: how-tos/advanced/multi-collection-one-page.md
# - Fix Claytons Card CSS: how-tos/advanced/fix-claytons-card-css.md
- Reference:
- Overview: reference/overview.md
- Lifecycle:
- Visibility:
- Overview: reference/lifecycle/visibility/overview.md
- Live Collections: reference/lifecycle/visibility/live.md
- Claytons Collections: reference/lifecycle/visibility/claytons.md
- Student view: reference/lifecycle/student-view.md # show both claytons and live
- Staff view:
- Overview: reference/lifecycle/staff-view.md
- Navigating: reference/lifecycle/navigating.md
- Editing:
- Overview: reference/lifecycle/editing/editing.md
- Edit Life Cycle: reference/lifecycle/editing/lifecycle.md
- Configure Collections: reference/lifecycle/editing/collections.md
- Configure Modules: reference/lifecycle/editing/modules.md
- Course copy:
- Importing Collections: reference/lifecycle/course-copy/overview.md
- How does import work: reference/lifecycle/course-copy/how-does-import-work.md
- Import reference: reference/lifecycle/course-copy/import.md
- Conceptual model:
- Collections' Conceptual Model: reference/conceptual-model/overview.md
- collections:
- Overview: reference/conceptual-model/collections/overview.md
# - 🚧 Live: reference/conceptual-model/collections/live.md
# - Visibility: reference/lifecycle/visibility/overview.md
- Existing collections: reference/conceptual-model/collections/existing-collections.md
- Add a new collection: reference/conceptual-model/collections/add-a-new-collection.md
- Representations:
- Overview: reference/conceptual-model/representations/overview.md
- Collections Only: reference/conceptual-model/representations/collections-only.md
- Griffith Cards: reference/conceptual-model/representations/griffith-cards.md
- Horizontal Cards: reference/conceptual-model/representations/horizontal-cards.md
- Assessment Table: reference/conceptual-model/representations/assessment-table.md
- Objects (Modules):
- Objects: reference/conceptual-model/objects/overview.md
- General: reference/conceptual-model/objects/general.md
- Dates: reference/conceptual-model/objects/dates.md
- Banner: reference/conceptual-model/objects/banner.md
- Metadata: reference/conceptual-model/objects/metadata.md
- Claytons:
- Claytons: reference/conceptual-model/representations/claytons/overview.md
- Update single collection: reference/conceptual-model/collections/update-single-collection.md
- Full Claytons: reference/conceptual-model/collections/full-claytons.md
- Fix common problems:
- Previously deleted configuration page: reference/problems/previously-deleted-configuration-page.md
- Failed to turn editing on: reference/problems/failed-to-turn-editing-on.md
- Development:
- Overview: reference/development/development-overview.md
- Local development: reference/development/local-development/overview.md
- Develop a representation: reference/development/representations/representation-development.md
- Configuration Page: reference/development/config-format.md
- Component Structure: reference/development/component-structure.md
- Data Structures: reference/development/data-structures.md
- "Community":
- Collections Community: community/collections-community.md
- "About":
- About Collections: about/about-collections.md
- Related work: about/related-work.md
- Rationale: about/rationale.md
- "Latest Version": about/latest-version.md
- Limitations:
- Limitations/limitations.md
# - ⚰️ Features & Use:
# - Overview: features.md
# - Collections: features/collections.md
# - Representations: features/representations.md
# - Objects: features/objects.md