morphium/mkdocs.yml at develop · Bardioc1977/morphium · 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
130
131
132
133
site_name: Morphium Documentation
site_description: MongoDB Object Document Mapper (ODM) and Messaging System for Java
site_author: Morphium Development Team
site_url: https://sboesebeck.github.io/morphium/

repo_name: morphium
repo_url: https://github.com/sboesebeck/morphium
edit_uri: edit/master/docs/

docs_dir: docs
site_dir: site
use_directory_urls: true

theme:
  name: material
  logo: assets/brand/morphium-mark-header.svg
  favicon: assets/brand/morphium-mark.svg
  palette:
    # Light mode
    - scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow

extra_css:
  - assets/extra.css

plugins:
  - search
  - tags

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
      title: On this page

# Internal design/planning documents - not part of the published site at all.
exclude_docs: |
  superpowers/

# Historical release notes are kept as plain files, deliberately not part of the nav
# (CHANGELOG.md in the repo root is the maintained changelog).
not_in_nav: |
  releases/*

nav:
  - Home: index.md
  - Getting Started:
    - Why Morphium?: why-morphium.md
    - Quick Start Tutorial: quickstart-tutorial.md
    - Your First Test: first-test.md
    - Overview: overview.md
    - Architecture: architecture-overview.md
    - Basic Setup: howtos/basic-setup.md
  - Testing & Development:
    - Test Runner: test-runner.md
    - InMemory Driver: inmemory-driver.md
    - Quick Reference: howtos/inmemory-driver.md
    - Wire Proxy (Fault Injection): wire-proxy.md
    - Developer Testing Guide: developer-testing-guide.md
  - PoppyDB:
    - Overview: poppydb.md
    - Production Deployment Playbook: howtos/poppydb-deployment.md
    - Admin Handbook: howtos/poppydb-admin-handbook.md
    - Migrating from MongoDB: howtos/migration-mongodb-to-poppydb.md
  - How-To Guides:
    - Upgrade v6.2→v6.3: howtos/migration-v6_2-to-v6_3.md
    - Upgrade v6.1→v6.2: howtos/migration-v6_1-to-v6_2.md
    - Migration v5→v6: howtos/migration-v5-to-v6.md
    - Aggregation Examples: howtos/aggregation-examples.md
    - Caching Examples: howtos/caching-examples.md
    - Cache Patterns: howtos/cache-patterns.md
    - Field Name Mapping: howtos/field-names.md
    - Optimistic Locking: howtos/optimistic-locking.md
    - References & Relationships: howtos/references-and-relationships.md
  - Core Features:
    - Messaging System: messaging.md
    - Messaging Implementations: howtos/messaging-implementations.md
    - SSL/TLS Connections: ssl-tls.md
    - Developer Guide: developer-guide.md
  - Extensions:
    - Jakarta Data: jakarta-data.md
    - Quarkus Extension: quarkus-extension.md
    - Spring Boot: spring-boot.md
  - Reference:
    - API Reference: api-reference.md
    - Configuration: configuration-reference.md
  - Operations:
    - v5 vs v6 Performance: v5-vs-v6-performance.md
    - Performance & Scalability: performance-scalability-guide.md
    - Production Deployment: production-deployment-guide.md
    - Monitoring & Metrics: monitoring-metrics-guide.md
    - Security Guide: security-guide.md
    - Troubleshooting: troubleshooting-guide.md
  - Contributing: contributing.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sboesebeck/morphium