feat: aling docs generation with template

Author: levinzonr

.github/workflows/docs.yml

@@ -29,7 +29,8 @@ jobs:
           restore-keys: |
             mkdocs-material-
       - run: |
-          ./gradlew dokkaHtmlMultiModule
-          mv build/dokka/htmlMultiModule docs/api
+          chmod +x ./generate_docs.sh
+          ./generate_docs.sh
+
       - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --force

.gitignore

@@ -14,3 +14,6 @@
 .cxx
 local.properties
 /build-logic/convention/build/
+
+# generated dokka files just, ignored just in case
+/docs/api/

docs/assets/favicon.ico

@@ -1,18 +1,44 @@
 :root {
-  --md-primary-fg-color:               #FFFF00;
-  --md-primary-fg-color--light:        #464A4D;
-  --md-primary-fg-color--dark:         #464A4D;
-  --md-primary-bg-color:               #464A4D;
-  --md-primary-bg-color--light:        #464A4D;
-
-  // Accent color shades
-  --md-accent-fg-color:                #000000;
-  --md-accent-fg-color--transparent:   #464A4D;
-  --md-accent-bg-color:                #464A4D;
-  --md-accent-bg-color--light:         #464A4D;
-}
 
+   /* Primary color shades - NavBar */
+  --md-primary-fg-color: yellow;
+  --md-primary-bg-color: black;
 
-:root>* {
---md-typeset-a-color: #656A6D;
+  /* Accent color shades - Hover effects */
+  --md-accent-fg-color: yellow;
+  --md-accent-fg-color--transparent: white;
+  --md-accent-bg-color: white;
 }
+
+:root > * {
+   /* background color */
+  --md-default-bg-color: #343434;
+
+  /* default text color */
+  --md-typeset-color: white;
+
+
+  --md-footer-fg-color: yellow;
+  --md-footer-bg-color: black;
+
+   /* color for markdown code blocks */
+  --md-code-fg-color: yellow;
+  --md-code-bg-color: #2B2B2B;
+
+  /* color for markdown headers */
+  --md-default-fg-color--light: white;
+
+  /* color for code highlighting, works kinda like Dracula Theme */
+  --md-code-hl-number-color: #A9B7C5;
+  --md-code-hl-special-color: #A9B7C5;
+  --md-code-hl-function-color: #A9B7C5;
+  --md-code-hl-constant-color: #A9B7C5;
+  --md-code-hl-keyword-color: #CB7832;
+  --md-code-hl-string-color: #6A8759;
+  --md-code-hl-name-color: #A9B7C5;
+  --md-code-hl-operator-color: #A9B7C5;
+  --md-code-hl-punctuation-color: #A9B7C5;
+  --md-code-hl-comment-color: #6A8759;
+  --md-code-hl-generic-color: #A9B7C5;
+  --md-code-hl-variable-color: #A9B7C5;
+}

docs/assets/logo.png

@@ -0,0 +1,8 @@
+
+# Copy the README.md And CHANGELOG.md to their respective tabs in MKDocs
+cp README.md docs/index.md
+cp CHANGELOG.md docs/changelog.md
+
+# Generate Dokka documentation for the project
+./gradlew dokkaHtmlMultiModule
+mv build/dokka/htmlMultiModule docs/api

docs/changelog.md

@@ -1,10 +1,33 @@
-site_name: My Docs
+site_name: Mosaic
+repo_url: https://github.com/monstar-lab-oss/android-mosaic
+
+
 extra_css:
   - stylesheets/extra.css
 theme:
+  logo: assets/logo.png
+  favicon: assets/favicon.ico
+
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.path
+    - navigation.sections
+    - navigation.sections.expand
   name: material
   palette:
     primary: custom
+    accent: custom
 
 nav:
   - 'API': api/
+  - 'Changelog': changelog.md
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences