mkdocs.yml

site_name: phpSPA Documentation
site_description: Component-Based PHP Library for Modern Web Applications
site_author: Dave Conco
site_url: https://phpspa.readthedocs.io

# Repository (replace with your repo)
repo_name: dconco/phpspa
repo_url: https://github.com/dconco/phpspa
edit_uri: edit/main/docs/

# Theme configuration
theme:
   name: material
   custom_dir: docs/overrides/
   palette:
      # Light mode
      - scheme: default
        primary: blue
        accent: indigo
        toggle:
           icon: material/brightness-7
           name: Switch to dark mode
      # Dark mode
      - scheme: slate
        primary: blue
        accent: indigo
        toggle:
           icon: material/brightness-5
           name: Switch to light mode
   features:
      - 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
   font:
      text: Inter
      code: JetBrains Mono
   icon:
      logo: material/code-braces
      repo: fontawesome/brands/github
      edit: material/pencil
      view: material/eye

# 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
   - Introduction: 1-introduction.md
   - Getting Started: 2-getting-started.md
   - Basics:
        - Creating Your First Component: 3-creating-your-first-component.md
        - Routing and Parameters: 4-routing-and-parameters.md
        - Route Patterns and Parameter Types: 5-route-patterns-and-param-types.md

   - Core Concepts:
        - Loading Events: 6-loading-events.md
        - Layout and Content Swap Mechanism: 7-layout-and-content-swap-mechanism.md
        - Component Rendering and Target Areas: 8-component-rendering-and-target-areas.md
        - Component Nesting: 10-component-nesting.md
        - Component Props: 11-component-props.md

   - Advanced Features:
        - Route Case Sensitivity: 12-route-case-sensitivity.md
        - Setting Page Titles: 13-setting-page-titles.md
        - Handling Error Routes: 14-handling-error-routes.md
        - JavaScript Navigation: 15-javascript-navigation.md
        - State Management: 17-state-management.md

   - Development:
        - Component Script and Styles: 18-component-script-and-styles.md
        - Handling Loading States: 19-handling-loading-states.md
        - Request Handling: 20-request-handling.md

   - phpSPA Hooks: hooks-event.md
   - Final Notes: final-notes.md

   - Integrations:
        - 🌱 Introduction: ./integrations/index.md
        - 🟢 Laravel Integration: ./integrations/laravel-integration.md
        - 🔵 Symfony Integration: ./integrations/symfony-integration.md
        - 🟡 CodeIgniter Integration: ./integrations/codeigniter-integration.md
        - 🟠 Pure PHP Integration: ./integrations/pure-php-integration.md

   - v1.1.0:
        - Introduction: ./v1.1/index.md
        - File Import Utility: ./v1.1/1-file-import-utility.md
        - State Management - map(): ./v1.1/2-mapping-in-state-management.md
        - Using Component Functions via HTML Tags: ./v1.1/3-using-component-functions-by-html-tags.md
        - Component Basics: ./v1.1/4-component-basics.md
        - Link Component: ./v1.1/5-link-component.md
        - HTML Attribute Array to String Conversion: ./v1.1/6-html-attribute-array-to-string-conversion.md
        - Redirect Function: ./v1.1/7-redirect-function.md
        - Navigate Component: ./v1.1/8-navigate-component.md

   - v1.1.2: ./v1.1.2/index.md

   - v1.1.5:
        - 🎉 Introduction: ./v1.1.5/index.md
        - 🗜️ Compression System: ./v1.1.5/1-compression-system.md
        - ⚡ PHP-JS Integration: ./v1.1.5/2-php-js-integration.md
        - 🏗️ Class Components: ./v1.1.5/3-class-components.md
        - 🔗 Method Chaining: ./v1.1.5/4-method-chaining.md
        - 🛡️ CSRF Protection: ./v1.1.5/5-csrf-protection.md
        - 📋 Migration Guide: ./v1.1.5/6-migration-guide.md

   - v1.1.7:
        - 🎉 Introduction: ./v1.1.7/index.md
        - 🎨 Global Asset Management: ./v1.1.7/1-global-asset-management.md
        - ⏰ Asset Caching Control: ./v1.1.7/2-asset-caching-control.md
        - 📋 Migration Guide: ./v1.1.7/3-migration-guide.md

   - v1.1.8: ./v1.1.8/index.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
   - git-revision-date-localized:
        enable_creation_date: true
        type: timeago
   - tags:
        tags_file: tags.md

# 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/discord
        link: https://discord.gg/FeVQs73C
        name: Join Discord
      - icon: fontawesome/brands/youtube
        link: https://youtube.com/@daveconco
        name: YouTube Channel
      - icon: fontawesome/solid/envelope
        link: mailto:concodave@gmail.com
        name: Email Contact
   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>.

# Custom CSS and JavaScript
extra_css:
   - assets/stylesheets/extra.css
   - assets/stylesheets/custom.css

extra_javascript:
   - assets/javascripts/extra.js
   - assets/javascripts/mathjax.js
   - https://polyfill.io/v3/polyfill.min.js?features=es6
   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Copyright
copyright: >
   Copyright &copy; 2025 <a href="https://github.com/dconco" target="_blank" rel="noopener">Dave Conco</a> –
   <a href="#__consent">Change cookie settings</a>