dss/mkdocs.yml at master · interuss/dss · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: DSS Deployment User Documentation
site_url: https://interuss.github.io/dss/
repo_url: https://github.com/interuss/dss
repo_name: interuss/dss
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/interuss
docs_dir: docs
edit_uri: edit/master/docs/
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  logo: assets/InterUSS_horizontal.svg
  palette:
    primary: "light blue"
    accent: "light blue"
  features:
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
    - navigation.instant # no page reload on navigation, behaves as a single page app
    - navigation.instant.prefetch # prefetches hovered links
    - navigation.instant.progress # displays loading progress bar if loading takes more than 400ms
    - navigation.tracking # tracks currently displayed page anchor in URL address
#    - navigation.tabs # displays top-level sections in menu below header
#    - navigation.sections # renders top-level sections as groups
    - navigation.path # shows breadcrumb above title
#    - navigation.indexes # allows attaching page to section
    - toc.follow # TOC in sidebar scrolls with page

    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
    - search.suggest # provides search completions


    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/
    - header.autohide # hides header on scroll down

    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/
    - navigation.footer # provides links to the previous and next page of the current page

    # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/
    - content.action.edit # provides link to edit page on github
    - content.action.view # provides link to view page on github

    # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#anchor-links--or-even-me
    - content.tabs.link

    # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
    - admonition
    - pymdownx.details
    - pymdownx.superfences

plugins:
  - search
  - awesome-nav
  - git-revision-date-localized: # displays last update date
      fallback_to_build_date: true
  - glightbox

markdown_extensions:
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  - admonition # enable use of call-outs
  - pymdownx.details # make call-outs collapsible
  - pymdownx.superfences:
      # https://squidfunk.github.io/mkdocs-material/reference/diagrams
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  # https://squidfunk.github.io/mkdocs-material/reference/lists
  - def_list # enables 'dl' description lists
  - pymdownx.tasklist: # enables '- [x]'/'- [ ]' task lists
      custom_checkbox: true

  # https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  - footnotes # enables '[^1]' footnotes

  # https://squidfunk.github.io/mkdocs-material/reference/data-tables/
  - tables # enables tables

  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions
  - pymdownx.betterem # improves markup detection
  - pymdownx.highlight: # enables code syntax highlighting
      anchor_linenums: true
      pygments_lang_class: true
      linenums: true # displays line numbers
  - pymdownx.inlinehilite # enables inline code syntax highlighting
  - pymdownx.smartsymbols # converts some symbols to their corresponding unicode equivalents
  - pymdownx.snippets # enables inclusion of markdown snippets
  - pymdownx.tabbed: # enables tabbed content
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify # enables links to tab as anchor
        kwds:
          case: lower
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown
  - toc:
      permalink: true # displays a permalink next to headings

  - attr_list  # Enable creation of custom anchors