codeigniter4-sse/mkdocs.yml at develop · maniaba/codeigniter4-sse · 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
site_name: CodeIgniter SSE
site_description: Redis and Mercure Server-Sent Events for CodeIgniter 4.
site_url: https://maniaba.github.io/codeigniter4-sse/
site_dir: build/site
repo_url: https://github.com/maniaba/codeigniter4-sse
edit_uri: edit/develop/docs/
copyright: Copyright &copy; 2026 Maniaba.

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/flame.svg
  favicon: assets/flame.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - content.action.edit
    - navigation.footer
    - navigation.instant
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: codeigniter
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra:
  homepage: https://maniaba.github.io/codeigniter4-sse/
  generator: false
  version:
    provider: mike
    default: latest
    alias: true
  social:
    - icon: material/github
      link: https://github.com/maniaba/codeigniter4-sse
      name: GitHub
    - icon: material/forum
      link: https://forum.codeigniter.com
      name: Forum CodeIgniter
    - icon: material/slack
      link: https://join.slack.com/t/codeigniterchat/shared_invite/zt-244xrrslc-l_I69AJSi5y2a2RVN~xIdQ
      name: Slack

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      use_pygments: false
  - pymdownx.superfences
  - tables

plugins:
  - search
  - mike:
      alias_type: redirect
      canonical_version: latest

extra_css:
  - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.8.0/build/styles/github.min.css
  - assets/css/codeigniter.css
  - assets/css/codeigniter_dark_mode.css

extra_javascript:
  - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.8.0/build/highlight.min.js
  - assets/js/hljs.js

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick start: quick-start.md
  - Configuration:
      - Overview: configuration.md
      - Channels and authorization: channels-and-authorization.md
      - Custom brokers: custom-brokers.md
  - Usage:
      - Browser client: browser-client.md
      - Mercure Hub: mercure.md
      - Streaming and deployment: deployment.md
  - Architecture:
      - Overview: architecture.md
  - Events: events.md
  - Examples: examples.md
  - Testing: testing.md
  - Troubleshooting: troubleshooting.md
  - Upgrade:
      - Upgrade policy: upgrade.md
  - Module structure: module-structure.md