docs-update/mkdocs.yml at develop · codeigniter4/docs-update · 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
# The nav, generated from the toctrees by admin/convert.php.
INHERIT: docs/.nav.yml

site_name: CodeIgniter
site_description: Main user guide for the CodeIgniter 4 framework

theme:
  name: material
  custom_dir: overrides
  logo: assets/flame.svg
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  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
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - content.code.copy
    - navigation.footer
    - content.action.edit
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - navigation.path
    - toc.follow

extra:
  homepage: https://codeigniter.com
  generator: false

  social:
    - icon: material/github
      link: https://github.com/codeigniter4/CodeIgniter4
      name: GitHub
    - icon: material/twitter
      link: https://twitter.com/CodeIgniterPhp
      name: X
    - 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

repo_name: codeigniter4/CodeIgniter4
repo_url: https://github.com/codeigniter4/CodeIgniter4
edit_uri: edit/develop/docs/
# overrides/partials/copyright.html replaces {year} with the build year.
copyright: Copyright &copy; 2019-{year} CodeIgniter Foundation.

validation:
  anchors: warn

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight:
      extend_pygments_lang:
        # Sphinx highlights PHP with startinline, so samples need no opening tag.
        - name: php
          lang: php
          options:
            startinline: true
  - toc:
      permalink: true
      toc_depth: 3
  - tables

extra_css:
  - assets/css/codeigniter.css
  - assets/css/codeigniter_dark_mode.css
  - assets/css/layout.css
  - assets/css/code.css

extra_javascript:
  - assets/js/shortcuts.js
  - assets/js/code.js