devops-docs/mkdocs.yml at main · uabrc/devops-docs · 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
site_name: UAB Research Computing DevOps Docs
repo_url: https://github.com/uabrc/devops-docs
edit_uri: blob/main/docs/

theme:
  name: material
  search_index_only: true
  custom_dir: theme
  language: en
  features:
    - navigation.indexes
    - navigation.instant
    - content.code.copy
    - content.action.edit
    - content.tabs.link
  favicon: images/favicon.png
  logo: images/logo.png

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

copyright: Copyright &copy; The University of Alabama at Birmingham.

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.keys
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - tables
  - toc:
      permalink: true

plugins:
  # order matters!
  - search
  - meta
  - blog:
      archive_date_format: MMMM yyyy
      archive_url_date_format: yyyy/MM
      blog_dir: news
      blog_toc: true
      post_date_format: full
      post_excerpt: required
      post_readtime: false
      categories_allowed:
        - Known Issues
        - Maintenance
        - Outreach
        - Releases
        - Survey
  - gen-files:
      scripts:
        - scripts/pandoc_generator.py
  - git-revision-date-localized:
      type: date
      strict: false
  - glightbox
  - table-reader:
      data_path: docs
  - title-casing

exclude_docs: |
  /**/res/*.md
  /**/_macro/
  /**/_template/

not_in_nav: |
  /**/res/*.md
  /**/_macro/
  /**/_template/

nav:
  - Home: index.md
  - Cheaha:
      - Archiving Modules: cheaha/archiving_modules.md
      - Shell Commands: cheaha/shell_commands.md
  - GitLab Runner:
      - Personal GitLab Runner Setup: gitlab_runner/personal_gitlab_runner_setup.md
  - Openstack:
      - VM Migration: openstack/vm_migration.md
      - VM Service Setup: service/service_setup.md
      - Share Openstack Image: openstack/share_image.md
  - Identity:
      - Saml: saml/saml.md
      - SP Metadata Generation: saml/create-sp-metadata.md
  - Ticket Issues: tickets.md

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn

watch:
  - macros
  - res
  - scripts
  - theme