cdk-constructs/mkdocs.yml at main · LayeredCraft/cdk-constructs · 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
site_name: LayeredCraft CDK Constructs
site_description: Reusable AWS CDK constructs for .NET serverless applications
site_url: https://layeredcraft.github.io/cdk-constructs/
site_author: LayeredCraft Team

# Repository
repo_name: LayeredCraft/cdk-constructs
repo_url: https://github.com/LayeredCraft/cdk-constructs
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2024 LayeredCraft Team

# 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:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Navigation
nav:
  - Home: index.md
  - Constructs:
    - Lambda Function: constructs/lambda-function.md
    - Static Site: constructs/static-site.md
    - DynamoDB Table: constructs/dynamodb-table.md
    - Cognito User Pool: constructs/cognito-user-pool.md
  - Testing: testing/index.md
  - Examples: examples/index.md

# Social links
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/LayeredCraft/cdk-constructs
      name: GitHub Repository
    - icon: fontawesome/solid/download
      link: https://www.nuget.org/packages/LayeredCraft.Cdk.Constructs/
      name: NuGet Package