linux-command-line-201/mkdocs.yml at main · UPPMAX/linux-command-line-201 · 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
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
site_name: Intermediate bash/Linux
repo_url: https://github.com/UPPMAX/naiss_intermediate_bash_linux
edit_uri: blob/main/docs/

site_description: Material for the course Intermediate bash/Linux
site_dir: site.build

theme:
  name: readthedocs
  locale: en
  logo:
    images/logo-cli-naiss.png
    #  static_templates:
    #- sitemap.html
  include_sidebar: true
  include_homepage_in_sidebar: true
  font:
    code: Robot Mono
  features:
    - toc.follow
    - toc.integrate
    - navigation.top
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.action.edit
    - content.action.view
  tabs: true
  language: en
  # Keyboard shortcuts for navigation, from https://www.mkdocs.org/user-guide/choosing-your-theme/
  shortcuts:
    help: 191    # ?
    next: 78     # n
    previous: 80 # p
    search: 83   # s

nav:
  - Common:
      - Home: index.md
      - Learning outcomes: learning_outcomes.md
      - Course dates: course_dates.md
      - Schedule: schedule.md
      - Prerequisites: prerequisites.md
      - Evaluation: evaluation.md
  - Lessons Morning (smarter command line):
      - Introduction: sessions/intro.md
      - Linux pipe: sessions/pipe.md
      - Linux permissions/owner: sessions/chown-chmod.md
      - Linux tools (wc, cut): sessions/wc_cut.md
      - sessions/regular_expressions_and_grep/README.md
      - sessions/sed/README.md
      - (optional) Using the AWK programming language: sessions/awk/README.md
  - Lessons Afternoon (smarter bash):
      - Scripting: sessions/scripting/README.md
      - Redirects: sessions/redirects.md
      - Environment variables: sessions/env_vars.md
      - Symbolic links: sessions/symlinks.md
      - Archiving/compressing data: sessions/arch.md
      - Quality of life: sessions/qual.md
  - Other teaching materials:
      - Books: books/README.md
      - Courses: courses.md
      - Videos: videos.md
  - Miscellaneous:
      - Communication: communication/README.md
      - Evaluations: evaluations/README.md
      - Lesson plans: lesson_plans/README.md
      - Meeting notes: meeting_notes/README.md
      - Reflections: reflections/README.md

not_in_nav: |
  communication/course_evaluation.md
  communication/course_information.md
  evaluations/20250602/README.md
  evaluations/20251204/README.md
  evaluations/20260601/README.md
  evaluations/20260204/README.md
  lesson_plans/20250602/README.md
  lesson_plans/20250603/README.md
  lesson_plans/20251204/README.md
  lesson_plans/20251205/README.md
  lesson_plans/20260601/README.md
  lesson_plans/20260602/README.md
  lesson_plans/20151204/README.md
  lesson_plans/20241205/README.md
  lesson_plans/20260204/README.md
  meeting_notes/20250403.md
  meeting_notes/20250409.md
  misc/test_admonitions.md
  misc/test_mermaid.md
  reflections/20241205/README.md
  reflections/20250602/README.md
  reflections/20250603/README.md
  reflections/202506_course/README.md
  reflections/20251204/README.md
  reflections/20251205/README.md
  reflections/202512_course/README.md
  reflections/20260601/README.md
  reflections/20260602/README.md
  reflections/202606_course/README.md
  reflections/20260204/README.md
  reflections/202602_course/README.md

plugins:
  - search
  - external-markdown
  - mkdocstrings
  - markdown-exec
  - open-in-new-tab
  - mermaid2: # Settings from https://mkdocs-mermaid2.readthedocs.io/en/master/#other-themes
      version: '9.4.3' # only works with version < 10
      arguments:
        theme: 'dark'
        themeVariables:
          primaryColor: '#BB2528'
          primaryTextColor: '#fff'
          primaryBorderColor: '#7C0000'
          lineColor: '#F8B229'
          secondaryColor: '#006100'
          tertiaryColor: '#fff'

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details # Makes admonitions collapsible, from https://mkdocs-material-rtd-test.readthedocs.io/en/latest/reference/admonitions/#details
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - smarty
  - pymdownx.details
  - pymdownx.superfences
  - codehilite
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      separator: "__"
  - admonition
  - pymdownx.details
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format