FletX/mkdocs.yml at master · AllDotPy/FletX · 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
site_name: FletX Framework
site_url: https://your-docs-url.com
repo_url: https://github.com/AllDotPy/FletX
repo_name: FletX

theme:
  name: material

  # LOGO AND FAVICON
  logo: assets/logo/fletx.png
  favicon: assets/logo/fletx.png
  language: en
  features:
    # - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - navigation.tracking
    - navigation.prune

    # - toc.integrate
    - toc.follow

    # SEARCH
    - search.suggest
    - search.highlight

    # CODE
    - code.copy
    - code.annotate
    - code.tabs
    - code.expand
    - content.code.copy
    - content.code.select

    # CONTENT ACTIONS
    - content.action.edit
    - content.action.view

  # PALETTE
  palette:
    - scheme: slate
      primary: indigo
      accent: light blue

  # FONTS
  font:
    text: Inter
    code: Chivo Mono

  # CODE STYLES
  hljs_style: monokai

# Extra JS files
extra_javascript:
  - assets/javascript/msdl.v1.js
  - assets/javascript/init_kapa_widget.v2.js

# Extra CSS files
extra_css:
  - assets/stylesheets/msdl.v2.css
  - assets/stylesheets/theme.v3.css

# NAVIGATION
nav:
  # HOME
  - Home: index.md

  # GETTING STARTED
  - Getting Started:
      - Introduction: getting-started/installation.md
      - FletX CLI: getting-started/fletx-cli.md
      - Architecture: getting-started/architecture.md
      - State Management: getting-started/state-management.md
      - Reactive Decorators: getting-started/decorators.md
      - Controllers: getting-started/controllers.md
      - Pages (views): getting-started/pages.md
      - Routing System: getting-started/routing.md
      - Dependency Injection: getting-started/dependency-injection.md
      - Services: getting-started/services.md

  # GUIDES
  # - Guides:

  # API REFERENCE
  - API Reference: api-reference.md

  # CONTRIBUTIONG
  - Contributing: contributing.md

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
      auto_title: true
      noclasses: true
      pygments_style: one-dark
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      # Use Twemoji for emojis
      # This is the default, but explicitly specifying for clarity
      # emoji_index: !!python/name:material.extensions.emoji.twemoji
      # emoji_generator: !!python/name:material.extensions.emoji.to_svg

  #
  - abbr
  - attr_list
  - md_in_html

plugins:
  - search
  # - i18n:
  #     default_language: en
  #     languages:
  #       - locale: en
  #         name: English
  #         default: true
  #         build: true
        # - locale: fr
        #   name: Français
        #   default: false
        #   build: true

  # - macros:
      # on_error_fail: true
      # include_dir: includes

# Extra metadata
extra:
  version: 0.1.4.dev1
  description: Documentation for FletX, a lightweight yet powerful framework that brings structured reactivity and clean architecture to Flet apps. It introduces controllers, services, and routers to help you separate logic, state, and UI with ease.

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AllDotPy/FletX
      name: FletX on GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/FletX_dev
      name: FletX on X