Skip to content

Commit 3a31432

Browse files
alxn4alxn4
authored
mkdocs update
1 parent 628213f commit 3a31432

File tree

1 file changed

+70
-180
lines changed

1 file changed

+70
-180
lines changed

‎mkdocs.yaml‎

Lines changed: 70 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
1-
site_name: Reflect-cpp
2-
site_description: fast serialization, deserialization and validation using reflection.
3-
strict: true
4-
site_url: https://docs.reflect-cpp.dev/
1+
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
2+
3+
site_name: "reflect-cpp"
4+
strict: false
5+
site_url: https://rfl.getml.com/
6+
site_author: Code17 GmbH
7+
site_description: >-
8+
A C++20 library for fast serialization, deserialization and validation using reflection.
9+
Supports JSON, BSON, CBOR, flexbuffers, msgpack, TOML, XML, YAML / msgpack.org[C++20]
510
611
theme:
7-
name: 'material'
8-
#custom_dir: 'docs/theme'
12+
name: "material"
913
palette:
1014
- media: "(prefers-color-scheme)"
1115
toggle:
1216
icon: material/brightness-5
1317
name: "Switch to light mode"
1418
- media: "(prefers-color-scheme: light)"
1519
scheme: default
16-
primary: deep purple
17-
accent: deep purple
20+
primary: getml
21+
accent: getml
1822
toggle:
1923
icon: material/brightness-2
2024
name: "Switch to dark mode"
2125
- media: "(prefers-color-scheme: dark)"
2226
scheme: slate
23-
primary: black
24-
accent: deep purple
27+
primary: getml
28+
accent: getml
2529
toggle:
2630
icon: material/brightness-6
2731
name: "Switch to system preference"
@@ -43,30 +47,21 @@ theme:
4347
- navigation.tracking
4448
- search.suggest
4549
- toc.follow
46-
logo: 'reflect-cpp-head.png'
47-
logo_dark_mode: "reflect-cpp-white.png"
48-
favicon: 'banner2.png'
50+
# logo: assets/images/rfl-favicon.png
51+
# favicon: assets/images/rfl-favicon-square.png
4952

5053
repo_name: getml/reflect-cpp
5154
repo_url: https://github.com/getml/reflect-cpp
5255
edit_uri: edit/main/docs/
56+
5357
extra:
54-
version:
55-
provider: patrick
56-
#analytics:
57-
# feedback:
58-
# title: Was this page helpful?
59-
# ratings:
60-
# - icon: material/thumb-up-outline
61-
# name: This page was helpful
62-
# data: 1
63-
# note: >-
64-
# Thanks for your feedback!
65-
# - icon: material/thumb-down-outline
66-
# name: This page could be improved
67-
# data: 0
68-
# note: >-
69-
# Thanks for your feedback!
58+
social:
59+
- icon: fontawesome/brands/github
60+
link: https://github.com/getml
61+
- icon: fontawesome/brands/youtube
62+
link: https://www.youtube.com/@code17-gmbh
63+
- icon: fontawesome/brands/linkedin
64+
link: https://www.linkedin.com/company/code17-gmbh
7065

7166
# https://www.mkdocs.org/user-guide/configuration/#validation
7267
#validation:
@@ -75,168 +70,63 @@ extra:
7570
# unrecognized_links: warn
7671

7772
extra_css:
78-
- 'assets/stylesheets/tweaks.css'
79-
# - 'extra/terminal.css'
80-
#extra_javascript:
81-
# - 'extra/feedback.js'
82-
# - 'extra/fluff.js'
83-
# - 'https://samuelcolvin.github.io/mkdocs-run-code/run_code_main.js'
73+
- assets/stylesheets/tweaks.css
8474

8575
exclude_docs: |
86-
README.md
8776
8877
nav:
89-
- Overview:
90-
- Welcome to Reflect-cpp: index.md
91-
- Why use Reflect-cpp: why.md
78+
- Welcome: index.md
79+
- Concepts:
80+
- Structs: concepts/structs.md
81+
- Custom Classes: concepts/custom_classes.md
82+
- Fields: concepts/field_syntax.md
83+
# - Type: concepts/types.md
84+
- Processors: concepts/processors.md
85+
# - Serialization: concepts/serialization.md
86+
# - Validators: concepts/validators.md
87+
# - Errors handling: concepts/errors.md
88+
- Supported Formats:
89+
- BSON: supported_formats/bson.md
90+
- CBOR: supported_formats/cbor.md
91+
- FlexBuffers: supported_formats/flexbuffers.md
92+
- JSON: supported_formats/json.md
93+
- JSON Schema: supported_formats/json_schema.md
94+
- MessagePack: supported_formats/msgpack.md
95+
- TOML: supported_formats/toml.md
96+
- UBJSON: supported_formats/ubjson.md
97+
- XML: supported_formats/xml.md
98+
- YAML: supported_formats/yaml.md
99+
- Custom Format: supported_formats/supporting_your_own_format.md
100+
# - Reflective Programming: ./reflective_programming.md
92101
- Installation: install.md
102+
- Documentation: docs-readme.md
93103
- Contributing: contributing.md
94-
- Changelog: changelog.md
95-
- Concepts:
96-
- Structs: concepts/structs.md
97-
- Custom Classes: concepts/custom_classes.md
98-
- Fields: concepts/field_syntax.md
99-
- Type: concepts/types.md
100-
- Processors: concepts/processors.md
101-
- Serialization: concepts/serialization.md
102-
- Validators: concepts/validators.md
103-
- Errors handling: concepts/errors.md
104-
- Supported Formats:
105-
- BSON: concepts/supported_formats/bson.md
106-
- CBOR: concepts/supported_formats/cbor.md
107-
- FlexBuffers: concepts/supported_formats/flexbuffers.md
108-
- JSON: concepts/supported_formats/json.md
109-
- JSON Schema: concepts/supported_formats/json_schema.md
110-
- MessagePack: concepts/supported_formats/msgpack.md
111-
- TOML: concepts/supported_formats/toml.md
112-
- XML: concepts/supported_formats/xml.md
113-
- YAML: concepts/supported_formats/yaml.md
114-
- Custom Format: concepts/supported_formats/supporting_your_own_format.md
115-
- Reflective Programming: ./reflective_programming.md
116-
- People: people.md
104+
- People: people.md
117105

118106
markdown_extensions:
119-
- tables
120-
- toc:
121-
permalink: true
122-
title: Page contents
123-
- admonition
124-
- pymdownx.details
125-
- pymdownx.superfences
126-
- pymdownx.highlight:
127-
pygments_lang_class: true
128-
- pymdownx.extra
129-
- pymdownx.emoji:
130-
emoji_index: !!python/name:material.extensions.emoji.twemoji
131-
emoji_generator: !!python/name:material.extensions.emoji.to_svg
132-
- pymdownx.tabbed:
133-
alternate_style: true
107+
- tables
108+
- def_list
109+
- toc:
110+
permalink: true
111+
title: Page contents
112+
- admonition
113+
- pymdownx.details
114+
- pymdownx.superfences
115+
- pymdownx.highlight:
116+
pygments_lang_class: true
117+
- pymdownx.extra
118+
- pymdownx.emoji:
119+
emoji_index: !!python/name:material.extensions.emoji.twemoji
120+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
121+
- pymdownx.tabbed:
122+
alternate_style: true
134123

135124
watch:
136-
- docs
125+
- docs
137126

138127
plugins:
139-
#- mike:
140-
# alias_type: symlink
141-
# canonical_version: latest
142-
- search
143-
#- exclude:
144-
# glob:
145-
# - theme/announce.html
146-
# - plugins/*
147-
# - __pycache__/*
148-
#- mkdocstrings:
149-
# handlers:
150-
# python:
151-
# paths: [.]
152-
# options:
153-
# members_order: source
154-
# separate_signature: true
155-
# filters: ["!^_"]
156-
# docstring_options:
157-
# ignore_init_summary: true
158-
# merge_init_into_class: true
159-
# show_signature_annotations: true
160-
# signature_crossrefs: true
161-
# extensions:
162-
# - docs/plugins/griffe_doclinks.py
163-
# import:
164-
# - https://docs.python.org/3/objects.inv
165-
#- mkdocs-simple-hooks:
166-
# hooks:
167-
# on_pre_build: 'docs.plugins.main:on_pre_build'
168-
# on_files: 'docs.plugins.main:on_files'
169-
# on_page_markdown: 'docs.plugins.main:on_page_markdown'
170-
#- redirects:
171-
# redirect_maps:
172-
# 'usage/mypy.md': 'integrations/mypy.md'
173-
# 'mypy_plugin.md': 'integrations/mypy.md'
174-
# 'datamodel_code_generator.md': 'integrations/datamodel_code_generator.md'
175-
# 'visual_studio_code.md': 'integrations/visual_studio_code.md'
176-
# 'hypothesis_plugin.md': 'integrations/hypothesis.md'
177-
# 'pycharm_plugin.md': 'integrations/pycharm.md'
178-
# 'usage/model_config.md': 'api/config.md'
179-
# 'usage/devtools.md': 'integrations/devtools.md'
180-
# 'usage/rich.md': 'integrations/rich.md'
181-
# 'usage/linting.md': 'integrations/linting.md'
182-
# 'usage/types.md': 'concepts/types.md'
183-
# 'usage/types/secrets.md': 'examples/secrets.md'
184-
# 'usage/types/string_types.md': 'api/types.md#pydantic.types.StringConstraints'
185-
# 'usage/types/file_types.md': 'api/types.md#pydantic.types.FilePath'
186-
# 'api/main.md': 'api/base_model.md'
187-
# 'api/color.md': 'api/pydantic_extra_types_color.md'
188-
# 'api/alias_generators.md': 'api/config.md#pydantic.config.ConfigDict.alias_generator'
189-
# 'api/pydantic_core_init.md': 'api/pydantic_core.md'
190-
# 'usage/types/booleans.md': 'api/standard_library_types.md#booleans'
191-
# 'usage/types/callables.md': 'api/standard_library_types.md#callable'
192-
# 'usage/types/custom.md': 'concepts/types.md#custom-types'
193-
# 'usage/types/datetime.md': 'api/standard_library_types.md#datetime-types'
194-
# 'usage/types/enum.md': 'api/standard_library_types.md#enum'
195-
# 'usage/types/json.md': 'api/types.md#pydantic.types.Json'
196-
# 'usage/types/list_types.md': 'api/standard_library_types.md#list'
197-
# 'usage/types/standard_types.md': 'api/standard_library_types.md'
198-
# 'usage/types/strict_types.md': 'concepts/types.md#strict-types'
199-
# 'usage/types/types.md': 'concepts/types.md'
200-
# 'usage/types/urls.md': 'api/networks.md'
201-
# 'usage/types/unions.md': 'api/standard_library_types.md#union'
202-
# 'usage/types/typevars.md': 'api/standard_library_types.md#type-and-typevar'
203-
# 'usage/types/types_fields.md': 'api/standard_library_types.md'
204-
# 'usage/validation_errors.md': 'errors/validation_errors.md'
205-
# 'usage/errors.md': 'errors/usage_errors.md'
206-
# 'usage/types/extra_types/color_types.md': 'api/pydantic_extra_types_color.md'
207-
# 'usage/types/extra_types/extra_types.md': 'api/pydantic_extra_types_color.md'
208-
# 'usage/types/extra_types/coordinate.md': 'api/pydantic_extra_types_coordinate.md'
209-
# 'usage/types/extra_types/mac_address.md': 'api/pydantic_extra_types_mac_address.md'
210-
# 'usage/types/extra_types/payment_cards.md': 'api/pydantic_extra_types_payment.md'
211-
# 'usage/types/extra_types/phone_numbers.md': 'api/pydantic_extra_types_phone_numbers.md'
212-
# 'usage/types/extra_types/routing_numbers.md': 'api/pydantic_extra_types_routing_numbers.md'
213-
# 'version-compatibility.md': 'version-policy.md'
214-
# 'api/pydantic_extra_types_routing_number.md': 'api/pydantic_extra_types_routing_numbers.md'
215-
# 'usage/computed_fields.md': 'api/fields.md#pydantic.fields.computed_field'
216-
# 'usage/conversion_table.md': 'concepts/conversion_table.md'
217-
# 'usage/dataclasses.md': 'concepts/dataclasses.md'
218-
# 'usage/fields.md': 'concepts/fields.md'
219-
# 'usage/json_schema.md': 'concepts/json_schema.md'
220-
# 'usage/models.md': 'concepts/models.md'
221-
# 'usage/postponed_annotations.md': 'concepts/postponed_annotations.md'
222-
# 'usage/pydantic_settings.md': 'concepts/pydantic_settings.md'
223-
# 'usage/serialization.md': 'concepts/serialization.md'
224-
# 'usage/strict_mode.md': 'concepts/strict_mode.md'
225-
# 'usage/type_adapter.md': 'concepts/type_adapter.md'
226-
# 'usage/validation_decorator.md': 'concepts/validation_decorator.md'
227-
# 'usage/validators.md': 'concepts/validators.md'
228-
# 'usage/types/bytesize.md': 'api/types.md#pydantic.types.ByteSize'
229-
# 'usage/types/dicts_mapping.md': 'api/standard_library_types.md#mapping-types'
230-
# 'usage/types/encoded.md': 'api/types.md#pydantic.types.EncodedBytes'
231-
# 'usage/types/enums.md': 'api/standard_library_types.md#enum'
232-
# 'usage/types/number_types.md': 'api/standard_library_types.md#number-types'
233-
# 'usage/types/sequence_iterable.md': 'api/standard_library_types.md#other-iterables'
234-
# 'usage/types/set_types.md': 'api/standard_library_types.md#sets'
235-
# 'usage/types/uuids.md': 'api/standard_library_types.md#uuid'
236-
# 'blog/pydantic-v2-alpha.md': 'https://blog.pydantic.dev/blog/2023/04/03/pydantic-v2-pre-release/'
237-
# 'blog/pydantic-v2-final.md': 'https://blog.pydantic.dev/blog/2023/06/30/pydantic-v2-is-here/'
238-
# 'blog/pydantic-v2.md': 'https://blog.pydantic.dev/blog/2022/07/10/pydantic-v2-plan/'
239-
#- external-markdown:
128+
- search
129+
- meta
240130

241131
hooks:
242-
- 'docs/plugins/main.py'
132+
- docs/plugins/main.py

0 commit comments

Comments
 (0)