Skip to content

Commit 7637b6e

Browse files
MFlisarWorkMFlisarWork
committed
new documentation
1 parent c9eb12e commit 7637b6e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+380
-201
lines changed

‎documentation/_data/other-projects.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ libraries:
2929
Compose:
3030
- name: ComposeChangelog
3131
link: https://mflisar.github.io/ComposeChangelog
32-
image: https://raw.githubusercontent.com/MFlisar/ComposeChangelog/main/documentation/docs/screenshots/overview.jpg
32+
image: https://raw.githubusercontent.com/MFlisar/ComposeChangelog/main/documentation/docs/screenshots/core/overview.jpg
3333
maven: io.github.mflisar.composechangelog/core
3434
description: This library offers you a a <b>changelog dialog</b> for compose including the ability to show new logs on app start only as well as filtering and customisation.
3535
- name: ComposeColors
3636
link: https://mflisar.github.io/ComposeColors
37-
image: https://raw.githubusercontent.com/MFlisar/ComposeColors/main/documentation/docs/screenshots/material.png
37+
image: https://raw.githubusercontent.com/MFlisar/ComposeColors/main/documentation/docs/screenshots/material/material.png
3838
maven: io.github.mflisar.composecolors/core
3939
description: A simple collection of colors that can be used inside any KMP compose project.
4040
- name: ComposeDebugDrawer
4141
link: https://mflisar.github.io/ComposeDebugDrawer
42-
image: https://raw.githubusercontent.com/MFlisar/ComposeDebugDrawer/main/documentation/docs/screenshots/demo2.jpg
42+
image: https://raw.githubusercontent.com/MFlisar/ComposeDebugDrawer/main/documentation/docs/screenshots/core/demo2.jpg
4343
maven: io.github.mflisar.composedebugdrawer/core
4444
description: This library offers you a <b>simple</b> and easily extendable <b>debug drawer</b>.
4545
- name: ComposeDialogs
@@ -54,6 +54,6 @@ libraries:
5454
description: This library offers you <b>preference screens</b> for compose including the ability of endless nesting subscreens as well as simple integration of custom preferences.
5555
- name: ComposeThemer
5656
link: https://mflisar.github.io/ComposeThemer
57-
image: https://raw.githubusercontent.com/MFlisar/ComposeThemer/main/documentation/docs/screenshots/demo.gif
57+
image: https://raw.githubusercontent.com/MFlisar/ComposeThemer/main/documentation/docs/screenshots/core/demo.gif
5858
maven: io.github.mflisar.composethemer/core
5959
description: This is a <b>full compose theme engine</b> that handles applying a theme as well as updating the system ui elements. Extendible and allows to simply apply user selected themes inside your app.

‎documentation/_data/project.yml

+127-90
Original file line numberDiff line numberDiff line change
@@ -9,160 +9,197 @@ library:
99
maven: io.github.mflisar.composepreferences
1010
maven-main-library: core
1111
multiplatform: true
12-
screenshots:
13-
- name: Changelog
12+
platforms:
13+
- jvm
14+
- android
15+
- ios
16+
screenshots:
17+
- name: core
1418
images:
15-
- ./screenshots/overview.jpg
16-
branch: main
19+
- ./screenshots/core/custom1.jpg
20+
- ./screenshots/core/custom2.jpg
21+
- ./screenshots/core/dependencies1.jpg
22+
- ./screenshots/core/dependencies2.jpg
23+
- ./screenshots/core/infos.jpg
24+
- ./screenshots/core/root.jpg
25+
- name: bool
26+
images:
27+
- ./screenshots/bool/bool.jpg
28+
- name: button
29+
images:
30+
- ./screenshots/button/button.jpg
31+
- name: color
32+
images:
33+
- ./screenshots/color/color.jpg
34+
- name: date
35+
images:
36+
- ./screenshots/date/date.jpg
37+
- name: input
38+
images:
39+
- ./screenshots/input/input.jpg
40+
- name: list
41+
images:
42+
- ./screenshots/list/list.jpg
43+
- name: number
44+
images:
45+
- ./screenshots/number/number.jpg
46+
- name: time
47+
images:
48+
- ./screenshots/time/time.jpg
49+
branch: master
1750
demo: true
1851

1952
# ------------
2053
# Dependencies
2154
# ------------
2255

23-
# optional
2456
dependencies:
25-
compose:
26-
cmp: 1.7.3
27-
compose: 1.7.5
28-
material3: 1.3.1
29-
experimental: true
57+
compose-multiplatform: 1.7.3 # https://github.com/JetBrains/compose-multiplatform/releases
58+
jetpack-compose-runtime: 1.7.6 # https://developer.android.com/jetpack/androidx/releases/compose-runtime
59+
jetpack-compose-material3: 1.3.1 # https://developer.android.com/jetpack/androidx/releases/compose-material3
60+
experimental: false
3061

31-
# -------------
32-
# Module
33-
# -------------
62+
# ------------
63+
# Groups
64+
# ------------
3465

35-
# GRUPPEN - optional: nur bei mehreren Modulen benötigt!
3666
groups:
3767
- name: core
3868
label: Core
39-
gradle-comment: core
40-
- name: screens
41-
label: Screens
42-
gradle-comment: screens
69+
gradle-comment: core
70+
- name: modules
71+
label: Modules
72+
gradle-comment: modules
4373
- name: extensions
4474
label: Extensions
4575
gradle-comment: extensions
4676

77+
# ------------
78+
# Modules
79+
# ------------
80+
4781
modules:
4882
- name: core
4983
group: core
50-
description: the core module to show a changelog
84+
description: provides all the basic preference classes and composables
5185
optional: false
5286
platforms:
53-
android: true
54-
ios: true
55-
jvm: true
56-
info:
57-
dependencies: []
87+
- jvm
88+
- android
89+
- ios
90+
platforms-info: ""
91+
dependencies:
92+
- name: ComposeDialogs
93+
link: https://github.com/MFlisar/ComposeDialogs
94+
version: 2.0.0
95+
- name: kotpreferences
96+
group: extensions
97+
description:
98+
optional: true
99+
platforms:
100+
- jvm
101+
- android
102+
- ios
103+
platforms-info: ""
104+
dependencies:
105+
- name: KotPreferences
106+
link: https://github.com/MFlisar/KotPreferences
107+
version: 0.7.2
58108
- name: screen-bool
59-
group: screens
60-
description: a boolean preference screen
109+
group: modules
110+
description: provides a checkbox/switch preference screen
61111
optional: true
62112
platforms:
63-
android: true
64-
ios: true
65-
jvm: true
66-
info:
113+
- jvm
114+
- android
115+
- ios
116+
platforms-info: ""
67117
dependencies: []
68118
- name: screen-button
69-
group: screens
70-
description: a button preference screen
119+
group: modules
120+
description: provides a button preference screen
71121
optional: true
72122
platforms:
73-
android: true
74-
ios: true
75-
jvm: true
76-
info:
123+
- jvm
124+
- android
125+
- ios
126+
platforms-info: ""
77127
dependencies: []
78-
- name: screen-input
79-
group: screens
80-
description: an input preference screen
81-
optional: true
82-
platforms:
83-
android: true
84-
ios: true
85-
jvm: true
86-
info:
87-
dependencies:
88-
- name: ComposeDialogs
89-
link: https://github.com/MFlisar/ComposeDialogs
90-
version: 2.0.0
91128
- name: screen-color
92-
group: screens
93-
description: a color preference screen
129+
group: modules
130+
description: provides a color picker preference screen
94131
optional: true
95132
platforms:
96-
android: true
97-
ios: true
98-
jvm: true
99-
info:
133+
- jvm
134+
- android
135+
- ios
136+
platforms-info: ""
100137
dependencies:
101138
- name: ComposeDialogs
102139
link: https://github.com/MFlisar/ComposeDialogs
103140
version: 2.0.0
104141
- name: screen-date
105-
group: screens
106-
description: a date preference screen
142+
group: modules
143+
description: provides a date picker preference screen
107144
optional: true
108145
platforms:
109-
android: true
110-
ios: true
111-
jvm: true
112-
info:
146+
- jvm
147+
- android
148+
- ios
149+
platforms-info: ""
113150
dependencies:
114151
- name: ComposeDialogs
115152
link: https://github.com/MFlisar/ComposeDialogs
116153
version: 2.0.0
117-
- name: screen-time
118-
group: screens
119-
description: an input preference screen
154+
- name: screen-input
155+
group: modules
156+
description: provides a input dialog preference screen
120157
optional: true
121158
platforms:
122-
android: true
123-
ios: true
124-
jvm: true
125-
info:
159+
- jvm
160+
- android
161+
- ios
162+
platforms-info: ""
126163
dependencies:
127164
- name: ComposeDialogs
128165
link: https://github.com/MFlisar/ComposeDialogs
129166
version: 2.0.0
130167
- name: screen-list
131-
group: screens
132-
description: a list preference screen
168+
group: modules
169+
description: provides a list preference screen
133170
optional: true
134171
platforms:
135-
android: true
136-
ios: true
137-
jvm: true
138-
info:
172+
- jvm
173+
- android
174+
- ios
175+
platforms-info: ""
139176
dependencies:
140177
- name: ComposeDialogs
141178
link: https://github.com/MFlisar/ComposeDialogs
142179
version: 2.0.0
143180
- name: screen-number
144-
group: screens
145-
description: a number preference screen
181+
group: modules
182+
description: provides a number picker preference screen
146183
optional: true
147184
platforms:
148-
android: true
149-
ios: true
150-
jvm: true
151-
info:
185+
- jvm
186+
- android
187+
- ios
188+
platforms-info: ""
152189
dependencies:
153190
- name: ComposeDialogs
154191
link: https://github.com/MFlisar/ComposeDialogs
155192
version: 2.0.0
156-
- name: extension-kotpreferences
157-
group: extensions
158-
description: an extension to use KotPreferences inside ComposePreferences
193+
- name: screen-time
194+
group: modules
195+
description: provides a time picker preference screen
159196
optional: true
160197
platforms:
161-
android: true
162-
ios: true
163-
jvm: true
164-
info:
198+
- jvm
199+
- android
200+
- ios
201+
platforms-info: ""
165202
dependencies:
166-
- name: KotPreferences
167-
link: https://github.com/MFlisar/KotPreferences
168-
version: 0.7.2
203+
- name: ComposeDialogs
204+
link: https://github.com/MFlisar/ComposeDialogs
205+
version: 2.0.0

‎documentation/_include/header.md

-10
This file was deleted.

0 commit comments

Comments
 (0)