www/simkube.yml at main · acrlabs/www · 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
---
site_name: SimKube
site_url: "https://simkube.dev/"
repo_url: "https://github.com/acrlabs/simkube"
docs_dir: simkube
site_dir: site/simkube
dev_addr: 127.0.0.1:8001
theme:
  name: null
  custom_dir: theme
  logo_path: /img/simkube_logo.png
  menu:
    icons: false
    mascot: true
    links:
      - documentation
      - community
      - FAQ
      - about
  footer:
    resources:
      - documentation
      - blog: "https://blog.appliedcomputing.io"
      - presentations: "https://www.youtube.com/playlist?list=PLOgtqKaB5McBaIN-XMtvhWAkz0HnCmjDo"
    community:
      - github: "https://github.com/acrlabs/simkube"
      - slack: "https://kubernetes.slack.com/archives/C07LTUB823Z"
    ACRL:
      - about: "https://appliedcomputing.io"
      - services: "https://appliedcomputing.io/services/"
      - research: "https://appliedcomputing.io/research/"
  static_templates:
    - search/index.html
extra_css:
  - style.css
plugins:
  - multirepo:              #  pull in docs from SimKube repo
      keep_docs_dir: true
  - markdown-exec            # execute commands from markdown (to generate usage code blocks)
  - search                   # search the docs
hooks:
  - hooks/preprocess.py      # convert GH-style markdown to mkdocs-style markdown (headings and such)
  - hooks/prebuild_css.py    # concatenate extra_css into css/style.css
  - hooks/changelog.py
markdown_extensions:
  - abbr                     # common abbreviations
  - admonition               # notes/warnings in documentation
  - md_in_html               # parse markdown inside HTML tags
  - pymdownx.blocks.html
  - pymdownx.blocks.details  # add "details" expanders for OpenAPI docs
  - pymdownx.highlight       # code highlighting
  - pymdownx.snippets:       # include contents of one file in another (used for interactive bokeh plots)
      check_paths: true
      base_path:
        - include
        - temp_dir
      auto_append:
        - glossary.md
  - pymdownx.superfences:    # parse mermaid code fences and executable code blocks
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - smarty                   # smart quotes/em dashes/etc
  - toc:                     # generate table of contents
      baselevel: 2           # page contents headings start at h2
      # because page contents headings start at h2, I don't want to include the
      # FAQ heading in the FAQ itself, so I set this from depth 3 to depth 3.
      toc_depth: '3-3'
nav:
  - SimKube: '!import https://github.com/acrlabs/simkube?branch=main&extra_imports=["CODE_OF_CONDUCT.md", "CHANGELOG.md"]&config=docs/mkdocs.yml'  # yamllint disable-line rule:line-length
  - SimKube CI: '!import https://github.com/acrlabs/simkube-ci-action?branch=main&config=docs/mkdocs.yml'
validation:
  nav:
    omitted_files: ignore