dynamo-mapper/mkdocs.yml at main · LayeredCraft/dynamo-mapper · 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
site_name: DynamoMapper
site_description: High-performance source generator for DynamoDB attribute mapping
site_url: https://layeredcraft.github.io/dynamo-mapper/
site_author: Nick Cipollina

# Repository
repo_name: layeredcraft/dynamo-mapper
repo_url: https://github.com/layeredcraft/dynamo-mapper
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2025 LayeredCraft

# Configuration
theme:
  name: material
  language: en
  logo: assets/icon.png
  favicon: assets/icon.png

  features:
    - content.code.copy
    - content.code.select
    - navigation.expand
    - navigation.footer
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  # Dark/Light mode toggle
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Roboto
    code: Roboto Mono

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

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Requirements: getting-started/requirements.md
    - Quick Start: getting-started/quick-start.md
  - Core Concepts:
    - How It Works: core-concepts/how-it-works.md
    - Source Generators: core-concepts/source-generators.md
    - Naming Conventions: core-concepts/naming-conventions.md
    - Single-Table Patterns: core-concepts/single-table-patterns.md
  - Usage:
    - Basic Mapping: usage/basic-mapping.md
    - Field Configuration: usage/field-configuration.md
    - Converters: usage/converters.md
    - Customization Hooks: usage/customization-hooks.md
    - DSL Configuration: usage/dsl-configuration.md
  - Examples:
    - Overview: examples/index.md
    - Single-Table Design: examples/single-table-design.md
    - Custom Converters: examples/custom-converters.md
    - Lambda Functions: examples/lambda-functions.md
    - Inheritance Mapping: examples/inheritance-mapping.md
  - Advanced:
    - Performance: advanced/performance.md
    - Diagnostics: advanced/diagnostics.md
    - Testing: advanced/testing.md
    - Troubleshooting: advanced/troubleshooting.md
  - API Reference:
    - Attributes: api-reference/attributes.md
    - Runtime Helpers: api-reference/runtime-helpers.md
    - Generated Code: api-reference/generated-code.md
  - Roadmap:
    - Phase 1: roadmap/phase-1.md
    - Phase 2: roadmap/phase-2.md
  - Contributing: contributing.md
  - Changelog: changelog.md

# Social links
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/layeredcraft/dynamo-mapper
      name: GitHub Repository
    - icon: fontawesome/solid/download
      link: https://www.nuget.org/packages/DynamoMapper/
      name: NuGet Package

# Custom CSS
extra_css:
  - assets/css/extra.css