Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
169 lines (161 loc) · 4.41 KB
/
Copy pathmkdocs.yml
File metadata and controls
169 lines (161 loc) · 4.41 KB
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Project information
site_name: InspeKtor
site_url: https://tabilzad.github.io/inspektor/
site_author: tabilzad
site_description: >-
OpenAPI (Swagger) specification generator for Ktor.
Generate complete API documentation from your Kotlin code at build time.
# Repository
repo_name: tabilzad/inspektor
repo_url: https://github.com/tabilzad/inspektor
edit_uri: edit/master/docs/
# Copyright
copyright: Copyright © 2025 tabilzad
# Configuration
theme:
name: material
logo: assets/logo.png
favicon: assets/favicon.png
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
scheme: slate
primary: indigo
accent: purple
font:
text: Inter
code: JetBrains Mono
language: en
# Plugins
plugins:
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- 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
auto_title: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: tabilzad
repo: inspektor
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page tree
nav:
- Home: index.md
- Getting Started:
- getting-started/index.md
- Installation: getting-started/installation.md
- Quick Start: getting-started/quick-start.md
- Sample Project: getting-started/sample-project.md
- Configuration:
- configuration/index.md
- Documentation Options: configuration/documentation-options.md
- Plugin Options: configuration/plugin-options.md
- Security Schemes: configuration/security-schemes.md
- Type Overrides: configuration/type-overrides.md
- Usage Guide:
- usage/index.md
- Defining Endpoints: usage/endpoints.md
- Request Bodies: usage/request-bodies.md
- Response Schemas: usage/responses.md
- Descriptions & Documentation: usage/descriptions.md
- Tags & Organization: usage/tags.md
- Path & Query Parameters: usage/parameters.md
- Advanced:
- advanced/index.md
- Polymorphic Types: advanced/polymorphic-types.md
- Generic Types: advanced/generic-types.md
- Ktor Resources: advanced/ktor-resources.md
- Incremental Compilation: advanced/incremental-compilation.md
- API Reference:
- api/index.md
- Annotations: api/annotations.md
- DSL Functions: api/dsl-functions.md
- Gradle DSL: api/gradle-dsl.md
- About:
- about/index.md
- Compatibility: about/compatibility.md
- Contributing: about/contributing.md
- License: about/license.md
# Additional configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/tabilzad/inspektor
name: InspeKtor on GitHub
generator: false
status:
new: Recently added
deprecated: Deprecated
extra_css:
- stylesheets/extra.css