contour/mkdocs.yml at master · buggylintermachine/contour · 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
site_name: Contour Terminal Emulator
dev_addr: 0.0.0.0:8080
docs_dir: docs
repo_url: https://github.com/contour-terminal/contour/
repo_name: contour-terminal/contour
site_description: Technical Landing Page for Contour Terminal Emulator
site_author: Christian Parpart
theme:
  name: material
  logo: /assets/contour-logo.png
  favicon: /assets/contour-logo.png
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: deep red
    accent: deep red
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode

  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: deep red
    accent: red
    toggle:
      icon: material/weather-night
      name: Switch to light mode
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.tabs.link
    - navigation.expand # Do we want this?
    - navigation.footer
    - navigation.indexes
    # - navigation.instant # conflicts with colorscheme preview
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
extra_css:
  - stylesheets/extra.css
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - admonition
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  - mkdocs-video:
      is_video: True
      video_muted: True
      video_controls: True
      css_style:
        width: "100%"
  - glightbox
  - exclude:
      glob:
        - 'drafts/*'
        - 'configuration/advanced/*' # disabled until ready
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])'

#Page tree
nav:
  - Home:
    - index.md
    - CONTRIBUTING.md
  - Getting started:
    - Installation: install.md
    - Release Notes: release-notes.md # This page is auto-generated from metainfo.xml by the CI/CD pipeline
  - Configuration:
    - configuration/index.md
    - configuration/profiles.md
    - configuration/layouts.md
    - configuration/colors.md
    - configuration/indicator-statusline.md
    - configuration/paths.md
    - configuration/key-mapping.md
    #- Images (Advanced) : configuration/advanced/images.md
    #- Mouse (Advanced) : configuration/advanced/images.md
    #- Misc (Advanced) : configuration/advanced/mouse.md
    #- Rendered (Advanced) : configuration/advanced/rendered.md
  - Features:
    - List of features: features.md
    - Persistent sessions: persistent-sessions.md
    - Font ligatures: demo/font-ligatures.md
    - Images: demo/images.md
    - ReGIS vector graphics: demo/regis-graphics.md
    - Input method editor (IME): demo/ime.md
    - Line marks: demo/line-marks.md
    - Status line: demo/statusline.md
    - Hint mode: demo/hint-mode.md
    - Input modes: input-modes.md
    - Accessibility: accessibility.md
    - Size indicator: demo/size_indicator.md
    - Git branch drawings: demo/git-branch-drawings.md
  - VT sequence reference:
    - vt-sequence/index.md
  - VT extensions:
    - vt-extensions/index.md
    - vt-extensions/clickable-links.md
    - vt-extensions/unicode-core.md
    - vt-extensions/vertical-line-marks.md
    - vt-extensions/color-palette-update-notifications.md
    # TODO(publish when ready): - vt-extensions/csi-u-extended-keyboard-protocol.md
    - vt-extensions/synchronized-output.md
    - vt-extensions/buffer-capture.md
    - vt-extensions/font-settings.md
    - vt-extensions/line-reflow-mode.md
    - vt-extensions/save-and-restore-sgr-attributes.md
    - vt-extensions/osc-133-shell-integration.md
    - vt-extensions/osc-3008-context.md
    - vt-extensions/osc-9-4-progress.md
    - vt-extensions/semantic-block-query.md
    - vt-extensions/private-use-glyphs.md
  - Internals:
    - internals/index.md
    - internals/CODING_STYLE.md
    - internals/vthost.md
    - internals/text-stack.md
    - internals/vt-conformance.md
    - internals/macos-code-signing.md