Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
127 lines (122 loc) · 3.93 KB
/
Copy pathmkdocs.yml
File metadata and controls
127 lines (122 loc) · 3.93 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
site_name: tinyconf
site_description: Go config structs filled from a chain of drivers, every package owns its part of the config and gets its changes without restart
site_url: https://insei.github.io/tinyconf/
repo_url: https://github.com/Insei/tinyconf
repo_name: Insei/tinyconf
edit_uri: edit/main/docs/
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.indexes
- navigation.top
- toc.follow
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- content.tabs.link
- content.action.edit
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to light mode
icon:
repo: fontawesome/brands/github
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/Insei/tinyconf
- icon: simple/go
link: https://pkg.go.dev/github.com/insei/tinyconf/v2
nav:
- Get started: index.md
- Why tinyconf?: why-tinyconf.md
- Use cases: use-cases.md
- Upgrading to v2: upgrading.md
- For AI agents: ai-agents.md
- Features:
- features/index.md
- Manager: features/manager.md
- Struct tags: features/tags.md
- Supported types: features/types.md
- Nested structs and sub configs: features/structs.md
- Required fields: features/required.md
- Value sources: features/sources.md
- Reloading: features/reloading.md
- Documentation generation: features/gendoc.md
- Logging: features/logging.md
- Drivers:
- drivers/index.md
- tag: drivers/tag.md
- yaml: drivers/yaml.md
- json: drivers/json.md
- toml: drivers/toml.md
- ini: drivers/ini.md
- properties: drivers/properties.md
- env: drivers/env.md
- flag: drivers/flag.md
- consul: drivers/consul.md
- vault: drivers/vault.md
- etcd: drivers/etcd.md
- Custom formats: drivers/format.md
- Custom drivers: drivers/custom.md
plugins:
- search
# llms.txt and llms-full.txt for AI agents: https://llmstxt.org
- llmstxt:
full_output: llms-full.txt
# the links point to the pages of the deployed version, it is set by the docs workflow
base_url: !ENV [LLMSTXT_BASE_URL, "https://insei.github.io/tinyconf/latest/"]
markdown_description: >-
tinyconf fills Go config structs from a chain of drivers by struct tags: defaults, YAML, JSON, TOML, INI,
properties, environment variables, flags, Consul, Vault and etcd. The next driver overrides the previous one.
Packages parse and subscribe to their own parts of the config, reloads create new versions of the config.
The module path is github.com/insei/tinyconf/v2.
sections:
Start:
- index.md: installation and the first config
- why-tinyconf.md: for whom and for what, comparison with viper, koanf, cleanenv
- use-cases.md: recipes
- upgrading.md: upgrading from v1
- ai-agents.md: the skill for AI agents
Features:
- features/*.md
Drivers:
- drivers/*.md