tenancy-bundle/mkdocs.yml at master · danplaton4/tenancy-bundle · 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
site_name: Tenancy Bundle
site_url: https://danplaton4.github.io/tenancy-bundle/
site_description: Multi-tenancy for Symfony. Zero boilerplate, zero leaks.
site_author: Dan Platon
repo_name: danplaton4/tenancy-bundle
repo_url: https://github.com/danplaton4/tenancy-bundle
edit_uri: edit/master/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.path
    - toc.follow
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      extend_pygments_lang:
        - name: php
          lang: php
          options:
            startinline: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - User Guide:
    - user-guide/index.md
    - Installation: user-guide/installation.md
    - Getting Started: user-guide/getting-started.md
    - Configuration Reference: user-guide/configuration.md
    - Database-per-Tenant: user-guide/database-per-tenant.md
    - Shared-DB Driver: user-guide/shared-db.md
    - Shared Entities: user-guide/shared-entities.md
    - Resolvers: user-guide/resolvers.md
    - Origin Header Resolver: user-guide/origin-header-resolver.md
    - Cache Isolation: user-guide/cache-isolation.md
    - Mailer Bootstrapper: user-guide/mailer-bootstrapper.md
    - Filesystem Bootstrapper: user-guide/filesystem-bootstrapper.md
    - Messenger Integration: user-guide/messenger.md
    - CLI Commands: user-guide/cli-commands.md
    - Profiler Tab: user-guide/profiler-tab.md
    - Testing: user-guide/testing.md
    - Strict Mode: user-guide/strict-mode.md
    - PHPStan Extension: user-guide/phpstan-extension.md
  - Operations:
    - Parallel Migrations: ops/parallel-migrations.md
    - Maintenance Mode: ops/maintenance-mode.md
    - Health Checks: ops/health-checks.md
  - Examples:
    - SaaS Subdomain: examples/saas-subdomain.md
    - API Header: examples/api-header.md
    - SaaS Demo (runnable): examples/saas-demo.md
  - Contributor Guide:
    - contributor-guide/index.md
    - Development Setup: contributor-guide/setup.md
    - Architecture Overview: contributor-guide/architecture.md
    - Test Infrastructure: contributor-guide/test-infrastructure.md
    - Coding Standards: contributor-guide/coding-standards.md
    - PR Workflow: contributor-guide/pr-workflow.md
    - Custom Resolver: contributor-guide/custom-resolver.md
    - Custom Bootstrapper: contributor-guide/custom-bootstrapper.md
  - Architecture Reference:
    - architecture/index.md
    - Event Lifecycle: architecture/event-lifecycle.md
    - DI Compilation Pipeline: architecture/di-compilation.md
    - DBAL Driver-Middleware: architecture/dbal-middleware.md
    - SQL Filter Internals: architecture/sql-filter.md
    - Messenger Stamp Lifecycle: architecture/messenger-lifecycle.md
    - Design Decisions: architecture/design-decisions.md
  - Roadmap: roadmap.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/danplaton4/tenancy-bundle