sonsofphp/mkdocs.yml at 6d3005decabc632e172d2e233537d5cf7e398975 · SonsOfPHP/sonsofphp · 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
118
119
120
121
122
123
124
125
126
127
128
129
site_name: Sons of PHP
site_url: https://docs.sonsofphp.com/
site_author: Joshua Estes
site_description: Sons of PHP creates and maintains helpful packages for PHP.

repo_url: https://github.com/SonsOfPHP/sonsofphp
repo_name: Mother Repository

copyright: Copyright &copy 2022 to Present Sons of PHP

edit_uri: https://github.com/SonsOfPHP/sonsofphp/edit/main/docs/

theme:
    name: material
    palette:
        scheme: slate
    features:
        #- navigation.instant
        - navigation.tabs
        #- navigation.sections
        - navigation.top
        - navigation.indexes
        - content.action.edit
        - content.action.view
        - content.code.annotate
        - content.code.copy
        - content.tabs.link
    icon:
        repo: fontawesome/brands/github

plugins:
    - search
    #- minify:
    #    minify_html: true

extra:
    #version:
    #    default: latest
    generator: false
    #version:
    #    provider: mike
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/SonsOfPHP
        - icon: fontawesome/brands/discord
          link: https://discord.gg/sdVxNhFqND

markdown_extensions:
    - admonition
    - meta
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.details
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - pymdownx.emoji
    - attr_list
    - md_in_html

nav:
    - Home:
        - index.md
        - Reporting Issues: reporting-issues.md
        - Contributing:
            - contributing/index.md
            - Documentation:
                - contributing/documentation/index.md
            - Code:
                - contributing/code/index.md
            - Discussions:
                - contributing/discussions/index.md
        - Getting Help: getting-help.md
        - Code of Conduct: code-of-conduct.md
        - Security Policy: security.md
    - Bard:
        - bard/index.md
    - Components:
        - components/index.md
        - Cache: components/cache/index.md
        - Clock: components/clock/index.md
        - Container: components/container/index.md
        - Cookie: components/cookie/index.md
        - CQRS:
            - components/cqrs/index.md
        - Event Dispatcher: components/event-dispatcher/index.md
        - Event Sourcing:
            - components/event-sourcing/index.md
            - Aggregates:
                - components/event-sourcing/aggregates/index.md
                - Storage:
                    - components/event-sourcing/aggregates/storage/index.md
            - Event Messages:
                - components/event-sourcing/event-messages/index.md
                - 'Using the Generic Event Message': components/event-sourcing/event-messages/generic-event-message.md
                - Storage:
                    - components/event-sourcing/event-messages/storage/index.md
                - Serializers:
                    - components/event-sourcing/event-messages/serializer/index.md
                - Enrichers:
                    - components/event-sourcing/event-messages/enricher/index.md
                - Upcasters:
                    - components/event-sourcing/event-messages/upcaster/index.md
        - Feature Toggle: components/feature-toggle/index.md
        - Filesystem:
            - components/filesystem/index.md
            - Adapters: components/filesystem/adapters.md
        - HttpFactory: components/http-factory/index.md
        - HttpHandler: components/http-handler/index.md
        - HttpMessage: components/http-message/index.md
        - JSON: components/json/index.md
        - Link: components/link/index.md
        - Logger: components/logger/index.md
        - Mailer: components/mailer/index.md
        - Money:
            - Overview: components/money/index.md
            - Currency Providers: components/money/currency-providers.md
            - Operators: components/money/operators.md
            - Queries: components/money/queries.md
        - Pager: components/pager/index.md
        - Version: components/version/index.md
    - Contracts:
        - contracts/index.md
        - Common: contracts/common/index.md
        - Cookie: contracts/cookie/index.md
        - Cqrs: contracts/cqrs/index.md
        - Mailer: contracts/mailer/index.md
        - Pager: contracts/pager/index.md
        - Validator: contracts/validator/index.md