cargs/mkdocs.yml at main · lucocozz/cargs · 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
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
170
171
172
173
site_name: cargs
site_description: Modern C library for command-line argument parsing
site_url: https://cargs.readthedocs.io
site_author: lucocozz
repo_name: lucocozz/cargs
repo_url: https://github.com/lucocozz/cargs
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2024 lucocozz

theme:
  name: material
  logo: assets/cargs-logo.webp
  favicon: assets/cargs-logo.webp
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      accent: purple
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - navigation.top
    - content.action.edit
    - content.action.download
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
          site_name: "cargs"
        - locale: fr
          name: Français
          build: true
          site_name: "cargs"
      default_language: en
      no_translation: "This page is not available in your language."
      languages_dirs:
        en: en
        fr: fr
      nav_translations:
        fr:
          Home: Accueil
          User Guide: Guide d'utilisation
          Installation: Installation
          Quick Start: Démarrage rapide
          Basic Options: Options de base
          Multi Values Options: Options multi-valeurs
          Option Formats: Formats d'options
          Subcommands: Sous-commandes
          Validation: Validation
          Environment Variables: Variables d'environnement
          API Reference: Référence API
          Overview: Aperçu
          Functions: Fonctions
          Macros: Macros
          Types: Types
          Regex Patterns: Motifs Regex
          Examples: Exemples
          Basic Usage: Utilisation de base
          Positional Arguments: Arguments positionnels
          Validations: Validations
          Advanced: Avancé
          Custom Handlers: Gestionnaires personnalisés
          Custom Validators: Validateurs personnalisés
          Regular Expressions: Expressions régulières
          Nested Commands: Commandes imbriquées
          Multi-Values: Multi-valeurs
          Contributing: Contribuer
          License: Licence
          # Misc: Divers

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - def_list
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: document
          class: document
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lucocozz/cargs
  generator: false

docs_dir: docs

nav:
  - Home: index.md
  - User Guide:
    - Installation: guide/installation.md
    - Quick Start: guide/quickstart.md
    - Basic Options: guide/basic-options.md
    - Multi Values Options: guide/multi-values.md
    - Option Formats: guide/option-formats.md
    - Subcommands: guide/subcommands.md
    - Validation: guide/validation.md
    - Environment Variables: guide/environment.md
  - API Reference:
    - Overview: api/overview.md
    - Functions: api/functions.md
    - Macros: api/macros.md
    - Types: api/types.md
    - Regex Patterns: api/regex_patterns.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Subcommands: examples/subcommands.md
    - Positional Arguments: examples/positional.md
    - Multi-Values: examples/multi-values.md
    - Validations: examples/validators.md
  - Advanced:
    - Custom Handlers: advanced/custom-handlers.md
    - Custom Validators: advanced/custom-validators.md
    - Regular Expressions: advanced/regex.md
    - Nested Commands: advanced/nested-commands.md
    - Multi-Values: advanced/multi-values.md
  - Contributing: contributing.md
  - License: license.md
  # - Misc:
    # - llm reference: misc/llm-references.md
    # - FAQ: misc/faq.md
    # - Changelog: misc/changelog.md
    # - Roadmap: misc/roadmap.md