docs/mkdocs.yml at 3.x · codefyphp/docs · 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
# Project information
site_name: CodefyPHP
site_description: "The web framework for complex applications"
site_author: "Joshua P."
site_url: https://codefyphp.com/docs/
# Copyright
copyright: 'Copyright &copy; 2025 Joshua Parker. All rights reserved.'
# Repository
repo_name: codefyphp/codefy
repo_url: https://github.com/codefyphp/codefy
edit_uri: ../docs/edit/3.x/docs/
# Configuration
theme:
  name: material
  custom_dir: overrides
  logo: images/CodefyLogoAvatar.png
  icon:
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
    edit: material/pencil
    view: material/eye
  palette:
    # Dark Mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: indigo
      accent: deep purple

    # Light Mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: purple
      accent: indigo
  show_title: true # show the title in the top bar
  show_stargazers: true # show the stargazers in the top bar
  favicon: images/favicon.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - content.code.copy
    - content.action.edit

extra:
  generator: false
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

extra_css:
  #- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/docco.min.css
  #- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/github.min.css
  #- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/felipec.min.css
  #- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/obsidian.min.css
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/atom-one-dark.min.css
  - stylesheets/extra.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js
  - javascript/init.js

plugins:
  - blog:
  - search:
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date.created
        as_update: date.updated
  - minify:
      minify_html: true
  - awesome-nav:
      filename: awesome_nav.yml
  - glightbox:
  - mkdocs-nav-weight:
      section_renamed: false
      index_weight: -10
      warning: true
      reverse: false
      headless_included: false
      default_page_weight: 1000
  - document-dates:
      position: bottom         # Display position: top(after title) bottom(end of document)
      type: date               # Date type: date datetime timeago, default: date
      exclude: # List of excluded files
        - temp.md              # Exclude specific file
        - drafts/*             # Exclude all files in drafts folder, including subfolders
        - blog/*
      date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y
      time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
      show_author: true        # Author display mode: true(avatar) text(text) false(hidden)
      recently-updated: true   # Whether to turn on recently updated data, default: false

markdown_extensions:
  codehilite:
  admonition:
  fenced_code:
  footnotes:
  pymdownx.highlight:
    anchor_linenums: true
    pygments_lang_class: true
  pymdownx.inlinehilite:
  pymdownx.blocks.details:
  pymdownx.tabbed:
  pymdownx.blocks.caption:
  pymdownx.details:
  pymdownx.superfences: