events-player/mkdocs.yml at main · bvandewe/events-player · 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
site_name: Cloudevent Player
site_description: CloudEvent Player API and UI
site_author: Bruno van de Werve
site_url: https://bvandewe.github.io/events-player/
repo_url: https://github.com/bvandewe/events-player
repo_name: events-player
docs_dir: docs
site_dir: site
dev_addr: 127.0.0.1:8884

watch:
    - docs/
    - mkdocs.yml

nav:
    - Home:
          - Welcome: index.md
          - Changelog: changelog.md
    - Getting Started:
          - Quick Start: quick-start.md
          - Installation: installation.md
    - Usage:
          - User Guide: usage.md
          - Configuration: configuration.md
    - Features:
          - Overview: features/index.md
          - Multiple Views: features/views.md
          - Filtering System: features/filtering.md
          - Client-Side Storage: features/storage.md
          - Server-Sent Events: features/sse.md
          - Background Tasks: features/tasks.md
          - Role-Based Access Control: features/rbac.md
          - Keyboard Shortcuts: features/keyboard-shortcuts.md
          - State Management: features/state-management.md
          - Performance: features/performance.md
    - Security:
          - Authentication & Authorization: authentication.md
          - RBAC Configuration Guide: rbac-guide.md
    - Deployment:
          - Deployment Guide: deployment.md

theme:
    name: material
    logo: assets/images/logo.png
    favicon: assets/images/logo.png
    features:
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.sections
        - navigation.top
        - navigation.tracking
        - navigation.path
        - search.highlight
        - search.share
        - search.suggest
        - content.code.copy
        - content.code.annotate
        - content.tags

    palette:
        - scheme: default
          primary: black
          accent: orange
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode
        - scheme: slate
          primary: black
          accent: orange
          toggle:
              icon: material/brightness-4
              name: Switch to light mode

markdown_extensions:
    - tables
    - admonition
    - attr_list # Enable grid
    - md_in_html
    - toc:
          permalink: true
          title: On this page
    - pymdownx.details
    - pymdownx.superfences:
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.highlight:
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.snippets:
          base_path: .
    - pymdownx.tabbed:
          alternate_style: true
          combine_header_slug: true
    - pymdownx.tasklist:
          custom_checkbox: true
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.smartsymbols
    - footnotes
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.smartsymbols
    - footnotes

plugins:
    - search:
          separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
    - awesome-pages
    - tags

extra:
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/bvandewe/events-player
          name: Event Player on GitHub
    version:
        provider: mike
        default: stable

extra_javascript:
    - https://unpkg.com/mermaid@11.2.1/dist/mermaid.min.js
    - assets/js/mermaid-simple-init.js
    - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
    - assets/js/tablesort-init.js

extra_css:
    - https://fonts.googleapis.com/css2?family=Montserrat:wght@300;400;500;600;700&display=swap
    - assets/css/custom.css
    - assets/css/table-sorting.css