mkdocs.yml

site_name: PhpSPA @V2
site_description: A component-based library for building modern, reactive user interfaces in pure PHP. Inspired by React. ✨
site_author: Dave Conco
site_url: https://phpspa.readthedocs.io

# Repository
repo_name: dconco/phpspa
repo_url: https://github.com/dconco/phpspa
edit_uri: edit/dev/docs/

# Theme configuration
theme:
   name: material
   custom_dir: docs/overrides/
   logo: img/phpspa-logo.png
   favicon: img/favicon.ico
   palette:
      # Light mode
      - scheme: default
        primary: deep purple
        accent: purple
        toggle:
           icon: material/brightness-7
           name: Switch to dark mode
      # Dark mode
      - scheme: slate
        primary: deep purple
        accent: purple
        toggle:
           icon: material/brightness-4
           name: Switch to light mode
   features:
      - announce.dismiss
      - navigation.instant
      - navigation.instant.prefetch
      - navigation.instant.progress
      - navigation.tracking
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.sections
      - navigation.expand
      - navigation.path
      - navigation.top
      - navigation.footer
      - navigation.indexes
      - search.highlight
      - search.share
      - search.suggest
      - content.action.edit
      - content.action.view
      - content.code.annotate
      - content.code.copy
      - content.code.select
      - content.tooltips
      - content.tabs.link
      - toc.follow
      - toc.integrate
      - header.autohide
   font:
      text: Inter
      code: JetBrains Mono
   icon:
      logo: material/code-braces
      repo: fontawesome/brands/github
      edit: material/pencil
      view: material/eye
      tag:
         default: octicons/tag-24

# Enhanced Markdown extensions
markdown_extensions:
   # Core extensions
   - abbr
   - admonition
   - attr_list
   - def_list
   - footnotes
   - md_in_html
   - tables
   - toc:
        permalink: true
        title: On this page

   # PyMdown extensions for enhanced functionality
   - pymdownx.arithmatex:
        generic: true
   - pymdownx.betterem:
        smart_enable: all
   - pymdownx.caret
   - pymdownx.details
   - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
        use_pygments: true
   - pymdownx.inlinehilite
   - pymdownx.keys
   - pymdownx.mark
   - pymdownx.smartsymbols
   - pymdownx.superfences:
        custom_fences:
           - name: mermaid
             class: mermaid
             format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.tabbed:
        alternate_style: true
        combine_header_slug: true
   - pymdownx.tasklist:
        custom_checkbox: true
   - pymdownx.tilde
   - pymdownx.snippets
   - pymdownx.critic
   - pymdownx.magiclink:
        repo_url_shorthand: true
        user: dconco
        repo: phpspa

# Navigation structure
nav:
   - Home: index.md
   - Getting Started:
      - Installation: installation.md
      - Core Concepts: core-concepts.md
      - The Layout: layout.md
   - Routing:
      - Defining Routes: routing/index.md
      - Advanced Routing: routing/advanced-routing.md
      - Component Configuration: routing/component-configuration.md
   - Components:
      - The Power of Components: components/index.md
      - Advanced Component Patterns: components/advanced-component.md
   - Navigation:
      - Link Component: navigations/link-component.md
      - Programmatic Navigation: navigations/navigate-component.md
   - PhpSPA Hooks:
      - useState Hook: hooks/use-state.md
      - Updating State Arrays: hooks/updating-state-of-mapped-arrays.md
      - useEffect Hook: hooks/use-effect.md
      - useFunction Hook: hooks/use-function.md
   - Request Handling:
      - Handling Requests & Sessions: requests/index.md
      - The Request Object: requests/request-object.md
      - Client-Side Events & API: requests/client-side-events-and-api.md
      - Auto-Reloading Components: requests/auto-reloading-components.md
      - API Authentication: requests/api-authentication.md
   - Security:
      - CSRF Protection: security/csrf-protection.md
      - Content Security Policy: security/content-security-policy.md
      - Handling CORS: security/cors.md
   - Performance & Assets:
      - HTML Compression: performance/html-compression.md
      - Managing Styles & Scripts: performance/managing-styles-and-scripts.md
      - Assets Caching: performance/assets-caching.md
   - API References:
      - Overview: references/index.md
      - HTTP & Networking:
         - Response API: references/response.md
         - Router API: references/router.md
         - App & Component Middleware: references/middleware.md
         - useFetch Hook: references/hooks/use-fetch.md
      - Helpers & Utilities:
         - fmt() Helper: references/helpers/fmt.md
         - File Import Utility: references/file-import-utility.md
         - DOM Utilities: references/dom-utilities.md
      - Performance:
         - Compression: references/compression.md
      - Components:
         - Component Meta Tags: references/component-meta.md
         - Component Preloading: references/preloading-component.md
      - Client Hooks:
         - Client useEffect (JS): references/hooks/clients/use-effect.md
         - Client useCallback (JS): references/hooks/clients/use-callback.md

# Enhanced plugins
plugins:
   - search:
        separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
   - minify:
        minify_html: true
        minify_js: true
        minify_css: true
        htmlmin_opts:
           remove_comments: true

# Extra configuration
extra:
   version:
      provider: mike
      default: latest
   social:
      - icon: fontawesome/brands/github
        link: https://github.com/dconco/phpspa
        name: GitHub Repository
      - icon: fontawesome/brands/twitter
        link: https://x.com/dave_conco
        name: Follow on Twitter
      - icon: fontawesome/brands/whatsapp
        link: https://chat.whatsapp.com/CFeGqXBMR7j2oLE1148A5f
        name: Join PhpSPA Community
      - icon: fontawesome/brands/youtube
        link: https://youtube.com/@daveconco
        name: YouTube Channel
      - icon: fontawesome/solid/envelope
        link: mailto:me@dconco.tech
        name: Email Contact
      - icon: fontawesome/brands/linkedin
        link: https://linkedin.com/in/dconco
        name: LinkedIn Profile
   generator: false
   analytics:
      feedback:
         title: Was this page helpful?
         ratings:
            - icon: material/emoticon-happy-outline
              name: This page was helpful
              data: 1
              note: >-
                 Thanks for your feedback!
            - icon: material/emoticon-sad-outline
              name: This page could be improved
              data: 0
              note: >-
                 Thanks for your feedback! Help us improve this page by
                 <a href="https://github.com/dconco/phpspa/issues/new/?title=[Docs%20Feedback]%20{title}%20-%20{url}" target="_blank" rel="noopener">telling us what you need</a>.

# Copyright
copyright: >
   Copyright &copy; 2026 <a href="https://github.com/dconco" target="_blank" rel="noopener">Dave Conco</a>. All rights reserved.