funql-dotnet/mkdocs.yml at main · funql/funql-dotnet · 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
# Project information
site_name: FunQL .NET
site_description: API Query Library
site_author: Xtracked
site_url: https://dotnet.funql.io/

# Repository
repo_url: https://github.com/funql/funql-dotnet
edit_uri: blob/main/docs/

# Copyright
copyright: >-
  Copyright &copy; 2025 Xtracked |
  <a href="https://www.xtracked.com/privacy-policy/" target="_blank" rel="noopener">Privacy policy</a>

# Configuration
theme:
  name: material
  language: en
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: teal
      accent: teal
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: teal
      accent: teal
  features:
    - navigation.sections
    - navigation.indexes
    - navigation.instant
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - toc.follow
  font:
    text: Roboto
    code: JetBrains Mono
  logo: assets/icon.png
  favicon: assets/favicon.png

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  - git-committers:
      repository: funql/funql-dotnet
      branch: main

# Additional configuration
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/funql

# Additional CSS
extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: docs
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

# Page tree
nav:
  - Introduction: index.md
  - Getting started: getting-started.md
  - Defining a schema:
    - defining-a-schema/index.md
    - Features:
      - defining-a-schema/features/index.md
      - Parse: defining-a-schema/features/parse.md
      - Validate: defining-a-schema/features/validate.md
      - Execute: defining-a-schema/features/execute.md
      - LINQ: defining-a-schema/features/linq.md
      - Visit: defining-a-schema/features/visit.md
      - Print: defining-a-schema/features/print.md
    - Requests: defining-a-schema/requests.md
    - Parameters:
      - defining-a-schema/parameters/index.md
      - Filter: defining-a-schema/parameters/filter.md
      - Sort: defining-a-schema/parameters/sort.md
      - Skip: defining-a-schema/parameters/skip.md
      - Limit: defining-a-schema/parameters/limit.md
      - Count: defining-a-schema/parameters/count.md
      - Input: defining-a-schema/parameters/input.md
    - Fields:
      - defining-a-schema/fields/index.md
  - Executing queries:
    - executing-queries/index.md
    - Execution pipeline: executing-queries/pipeline.md
  - Integrations:
    - integrations/index.md
    - Entity Framework Core: integrations/efcore.md
    - NodaTime: integrations/nodatime.md
    - Newtonsoft.Json: integrations/newtonsoftjson.md
  - Examples:
    - examples/index.md
    - Basic: examples/basic.md
    - WebApi: examples/webapi.md
  - Additional resources:
    - Design philosophy: additional-resources/design-philosophy.md
    - Licensing: additional-resources/licensing.md