new documentation

MFlisar · Jan 20, 2025 · f69999a · f69999a
1 parent 3c007c8
commit f69999a
Show file tree

Hide file tree

Showing 54 changed files with 407 additions and 596 deletions.
diff --git a/documentation/_data/other-projects.yml b/documentation/_data/other-projects.yml
@@ -29,17 +29,17 @@ libraries:
   Compose:
     - name: ComposeChangelog
       link: https://mflisar.github.io/ComposeChangelog
-      image: https://raw.githubusercontent.com/MFlisar/ComposeChangelog/main/documentation/docs/screenshots/overview.jpg
+      image: https://raw.githubusercontent.com/MFlisar/ComposeChangelog/main/documentation/docs/screenshots/core/overview.jpg
       maven: io.github.mflisar.composechangelog/core
       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.
     - name: ComposeColors
       link: https://mflisar.github.io/ComposeColors
-      image: https://raw.githubusercontent.com/MFlisar/ComposeColors/main/documentation/docs/screenshots/material.png
+      image: https://raw.githubusercontent.com/MFlisar/ComposeColors/main/documentation/docs/screenshots/material/material.png
       maven: io.github.mflisar.composecolors/core
       description: A simple collection of colors that can be used inside any KMP compose project.
     - name: ComposeDebugDrawer
       link: https://mflisar.github.io/ComposeDebugDrawer
-      image: https://raw.githubusercontent.com/MFlisar/ComposeDebugDrawer/main/documentation/docs/screenshots/demo2.jpg
+      image: https://raw.githubusercontent.com/MFlisar/ComposeDebugDrawer/main/documentation/docs/screenshots/core/demo2.jpg
       maven: io.github.mflisar.composedebugdrawer/core
       description: This library offers you a <b>simple</b> and easily extendable <b>debug drawer</b>.
     - name: ComposeDialogs
@@ -54,6 +54,6 @@ libraries:
       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.
     - name: ComposeThemer
       link: https://mflisar.github.io/ComposeThemer
-      image: https://raw.githubusercontent.com/MFlisar/ComposeThemer/main/documentation/docs/screenshots/demo.gif
+      image: https://raw.githubusercontent.com/MFlisar/ComposeThemer/main/documentation/docs/screenshots/core/demo.gif
       maven: io.github.mflisar.composethemer/core
       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.
diff --git a/documentation/_data/project.yml b/documentation/_data/project.yml
@@ -9,166 +9,176 @@ library:
   maven: io.github.mflisar.lumberjack
   maven-main-library: core
   multiplatform: true
-  screenshots:
-    - name: Logs
+  platforms:
+    - jvm
+    - android
+    - macos
+    - ios
+  screenshots: 
+    - name: core
       images:
-        - ./screenshots/log1.png
-        - ./screenshots/log2.png
-    - name: Compose Viewer
+        - ./screenshots/core/log1.png
+        - ./screenshots/core/log2.png
+    - name: composeviewer
       images:
-        - ./screenshots/compose-viewer1.jpg
-        - ./screenshots/compose-viewer2.jpg
+        - ./screenshots/composeviewer/compose-viewer1.jpg
+        - ./screenshots/composeviewer/compose-viewer2.jpg
+    - name: viewer
+      images:
+        - ./screenshots/viewer/viewer1.jpg
+        - ./screenshots/viewer/viewer2.jpg
   branch: master
   demo: true
 
 # ------------
 # Dependencies
 # ------------
 
-# optional
 dependencies:
-  compose:
-    cmp: 1.7.1
-    compose: 1.7.5
-    material3: 1.3.1
-    experimental: true
+  compose-multiplatform: 1.7.1 # https://github.com/JetBrains/compose-multiplatform/releases
+  jetpack-compose-runtime: 1.7.5 # https://developer.android.com/jetpack/androidx/releases/compose-runtime
+  jetpack-compose-material3: 1.3.1 # https://developer.android.com/jetpack/androidx/releases/compose-material3
+  experimental: false
+
+# ------------
+# Groups
+# ------------
+
+groups:
+  - name: core
+    label: Core
+    gradle-comment: core
+  - name: lumberjack
+    label: Lumberjack
+    gradle-comment: if you want to use the lumberjack logger
+  - name: extensions
+    label: Extensions
+    gradle-comment: extensions that work with any implementation
+  - name: timber
+    label: Timber
+    gradle-comment: if you want to use the timber logger
 
-# -------------
-# Module
-# -------------
+# ------------
+# Modules
+# ------------
 
 modules:
-  - name: "core"
-    group: "core"
-    description: "the core module - must always be included"
-    optional: false
-    platforms:
-      android: true
-      ios: true
-      jvm: true
-      info:
-    #dependencies:         # optionales Array
-  - name: "implementation-lumberjack"
-    group: "lumberjack"
-    description: "the main implementation of the logger - either this or the timber implementation must always be included"
+  - name: core
+    group: core
+    description: the core module of lumberjack
     optional: false
     platforms:
-      android: true
-      ios: false
-      jvm: true
-      info: "(1)"
-    #dependencies:         # optionales Array
-  - name: "logger-console"
-    group: "lumberjack"
-    description: "a console logger for the lumberjack implementation"
-    optional: true
-    platforms:
-      android: true
-      ios: false
-      jvm: true
-      info: "(2)"
-    #dependencies:         # optionales Array
-  - name: "logger-file"
-    group: "lumberjack"
-    description: "a file logger for the lumberjack implementation"
+      - jvm
+      - android
+      - macos
+      - ios
+    platforms-info: ""
+    dependencies: []
+  - name: extension-composeviewer
+    group: extensions
+    description: a compose viewer for lumberjack
     optional: true
     platforms:
-      android: true
-      ios: true
-      jvm: true
-      info:
-    #dependencies:         # optionales Array
-  - name: "extension-feedback"
-    group: "ext"
-    description: "an extension for easy email feedbacks"
+      - jvm
+      - android
+    platforms-info: (5)
+    dependencies:
+      - name: FeedbackManager
+        link: https://github.com/MFlisar/FeedbackManager
+        version: 2.1.0
+  - name: extension-feedback
+    group: extensions
+    description: a feedback module for lumberjack
     optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(3)"
-    dependencies:         # optionales Array
+      - android
+    platforms-info: (3)
+    dependencies:
       - name: FeedbackManager
-        link: https://mflisar.github.io/FeedbackManager/
+        link: https://github.com/MFlisar/FeedbackManager
         version: 2.1.0
-  - name: "extension-notification"
-    group: "ext"
-    description: "an extension for exception notification with easy email feedbacks on click"
+  - name: extension-notification
+    group: extensions
+    description: a notification module for lumberjack
     optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(3)"
-    dependencies:         # optionales Array
+      - android
+    platforms-info: (3)
+    dependencies:
       - name: FeedbackManager
-        link: https://mflisar.github.io/FeedbackManager/
+        link: https://github.com/MFlisar/FeedbackManager
         version: 2.1.0
-  - name: "extension-viewer"
-    group: "ext"
-    description: "a log viewer based on XML"
+  - name: extension-viewer
+    group: extensions
+    description: a xml viewer for lumberjack
     optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(4)"
-    dependencies: # optionales Array
+      - android
+    platforms-info: (4)
+    dependencies:
       - name: FeedbackManager
-        link: https://mflisar.github.io/FeedbackManager/
+        link: https://github.com/MFlisar/FeedbackManager
         version: 2.1.0
       - name: FastScroller
         link: https://github.com/quiph/RecyclerView-FastScroller
         version: 1.0.0
-  - name: "extension-composeviewer"
-    group: "ext"
-    description: "a compsoe log viewer"
+  - name: implementation-lumberjack
+    group: lumberjack
+    description: the core lumberjack implementation
     optional: true
     platforms:
-      android: true
-      ios: true
-      jvm: true
-      info: "(5)"
-    dependencies:         # optionales Array
-      - name: FeedbackManager
-        link: https://mflisar.github.io/FeedbackManager/
-        version: 2.1.0
-  - name: "implementation-timber"
-    group: "timber"
-    description: "the main implementation based on timber of the logger - either this or the lumberjack implementation must always be included"
-    optional: false
+      - jvm
+      - android
+    platforms-info: (1)
+    dependencies: []
+  - name: implementation-timber
+    group: timber
+    description: the core timber based implementation of lumberjack
+    optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(6)"
-    dependencies:         # optionales Array
+      - android
+    platforms-info: (6)
+    dependencies:
       - name: Timber
         link: https://github.com/JakeWharton/timber
         version: 4.7.1
-  - name: "logger-timber-console"
-    group: "timber"
-    description: "a console logger for the timber implementation"
+  - name: logger-console
+    group: lumberjack
+    description: a console logger for lumberjack
+    optional: true
+    platforms:
+      - jvm
+      - android
+    platforms-info: (2)
+    dependencies: []
+  - name: logger-file
+    group: lumberjack
+    description: a file logger for lumberjack
+    optional: true
+    platforms:
+      - jvm
+      - android
+    platforms-info: ""
+    dependencies: []
+  - name: logger-timber-console
+    group: timber
+    description: a console logger for the lumberjack timber implementation
     optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(6)"
-    dependencies:         # optionales Array
+      - android
+    platforms-info: (6)
+    dependencies:
       - name: Timber
         link: https://github.com/JakeWharton/timber
         version: 4.7.1
-  - name: "logger-timber-file"
-    group: "timber"
-    description: "a file logger for the timber implementation"
+  - name: logger-timber-file
+    group: timber
+    description: a file logger for the lumberjack timber implementation
     optional: true
     platforms:
-      android: true
-      ios: false
-      jvm: false
-      info: "(6)"
-    dependencies:         # optionales Array
+      - android
+    platforms-info: (6)
+    dependencies:
       - name: Timber
         link: https://github.com/JakeWharton/timber
         version: 4.7.1
@@ -177,19 +187,4 @@ modules:
         version: 2.0.7
       - name: logback-android
         link: https://github.com/tony19/logback-android
-        version: 3.0.0
-
-# GRUPPEN - optional: nur bei mehreren Modulen benötigt!
-groups:
-  - name: core
-    label: Core
-    gradle-comment: "core module"
-  - name: lumberjack
-    label: Lumberjack
-    gradle-comment: "if you want to use the lumberjack logger"
-  - name: ext
-    label: Extensions
-    gradle-comment: "extensions that work with any implementation"
-  - name: timber
-    label: Timber
-    gradle-comment: "if you want to use the timber logger"
+        version: 3.0.0
diff --git a/documentation/_include/header.md b/documentation/_include/header.md