-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathmkdocs.yml
133 lines (124 loc) · 4.17 KB
/
mkdocs.yml
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
# Project Information
# https://www.mkdocs.org/user-guide/configuration/#project-information
site_name: Ktor OpenAPI Tools
site_url: https://smiley4.github.io/ktor-openapi-tools/
site_description: A collection of libraries to simplify API documentation and exploration for Ktor applications. Generates OpenAPI specifications and provides Swagger UI and ReDoc.
# Repository
repo_name: ktor-openapi-tools
repo_url: https://github.com/SMILEY4/ktor-openapi-tools
# Documentation Layout
# https://www.mkdocs.org/user-guide/configuration/#documentation-layout
nav:
- Home: index.md
- OpenAPI:
- openapi/index.md
- Getting Started: openapi/getting_started.md
- Plugin Configuration: openapi/plugin_configuration.md
- Documenting Routes: openapi/documenting_routes.md
- Type-safe Routing: openapi/typesafe_routing.md
- Handling Types, Schemas and Examples: openapi/handling_types_schemas_examples.md
- Schema Generation: openapi/schema_generation.md
- Example Encoding: openapi/example_encoding.md
- Multiple API Specifications: openapi/multiple_specs.md
- API Reference: dokka/ktor-openapi/index.html
- Swagger UI:
- swaggerui/index.md
- Getting Started: swaggerui/getting_started.md
- API Reference: dokka/ktor-swagger-ui/index.html
- ReDoc:
- redoc/index.md
- Getting Started: redoc/getting_started.md
- API Reference: dokka/ktor-redoc/index.html
- Examples:
- examples/index.md
- Basics: examples/basics.md
- Requests and Responses: examples/request-response.md
- Authentication: examples/authentication.md
- File Upload: examples/file-upload.md
- Webhooks: examples/webhooks.md
- Schema Handling: examples/schemas.md
- Schema Generator: examples/customized-schema-generator.md
- Example Handling: examples/openapi-examples.md
- Kotlinx Serialization: examples/kotlinx-serialization.md
- Petstore: examples/petstore.md
- Multiple Specs: examples/multiple-specs.md
- External OpenAPI Spec: examples/external-openapi-spec.md
- Complete Configuration: examples/complete-configuration.md
- Changelog: changelog.md
# Validation
# # https://www.mkdocs.org/user-guide/configuration/#validation
validation:
nav:
omitted_files: warn
not_found: warn
absolute_links: warn
links:
not_found: warn
absolute_links: warn
unrecognized_links: warn
# Configuration
# https://www.mkdocs.org/user-guide/configuration/#build-directories
theme:
name: material
icon:
logo: material/library
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.expand
- navigation.indexes
- navigation.footer
- toc.integrate
- search.suggest
- search.share
- content.code.copy
- content.code.annotate
extra_css:
- assets/stylesheets/extra.css
extra:
version:
provider: mike
plugins:
- search
- privacy
# Formatting Options
# https://www.mkdocs.org/user-guide/configuration/#formatting-options
markdown_extensions:
# https://python-markdown.github.io/extensions/
- attr_list
- admonition
- md_in_html
- tables
# https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/
- pymdownx.betterem:
smart_enable: all
- pymdownx.details
- pymdownx.snippets:
base_path: [ 'examples/src/main/kotlin/io/github/smiley4/ktoropenapi/examples' ]
dedent_subsections: True
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- './docs/assets/icons'