Update mkdocs site

docs/css/app.css → docs/assets/css/app.css

@@ -15,3 +15,8 @@
  *
  */
 
+:root {
+  --md-primary-fg-color: #007BFF;
+  --md-primary-fg-color--light: #288EFA;
+  --md-primary-fg-color--dark: #005DC1;
+}

docs/assets/js/app.js

@@ -0,0 +1,8 @@
+console.log(`
+       _))        
+      > *\\     _~  
+      \`;'\\\\__-' \\_ 
+         | )  _ \\ \\
+        / / \`\`   w w
+       w w
+`);

docs/index.md

@@ -1 +1,48 @@
-# Welcome
+# Welcome to kmmify
+
+Welcome to the official documentation for **kmmify**—a robust and refined template designed to
+supercharge your Kotlin Multiplatform development. Our template simplifies the process of building
+cross-platform applications by sharing business logic across iOS, Android, Web, and Desktop
+platforms, while accommodating platform-specific nuances.
+
+## Why kmmify?
+
+**kmmify** was born out of a need to refine and optimize the official Kotlin Multiplatform Library
+template. By reworking it significantly, we've tailored a template that not only meets the evolving
+demands of modern software projects but also offers a streamlined setup process that gets you up and
+running swiftly. This template is ideal for developers looking to leverage Kotlin Multiplatform's
+true potential by facilitating shared codebases across multiple platforms.
+
+## Features
+
+- **Unified Project Structure**: Organize and maintain a single codebase that runs on all major
+  platforms.
+- **Pre-configured Build Scripts**: Jumpstart your development with ready-to-use Gradle scripts.
+- **Integrated Code Analysis**: Maintain high-quality code with Detekt integrated for static code
+  analysis.
+- **Ready-to-Deploy Documentation**: Comes with MkDocs configuration for immediate project
+  documentation setup.
+
+## Getting Started
+
+To get started with **kmmify**, clone the repository and build your project using the following
+commands:
+
+```shell
+git clone https://github.com/goatbytes/kmmify.git
+cd kmmify
+./gradlew build
+```
+
+## About GoatBytes.IO
+
+![GoatBytesLogo](assets/img/banner.png)
+
+At **GoatBytes.IO**, our mission is to develop secure software solutions that empower businesses to
+transform the world. With a focus on innovation and excellence, we strive to deliver cutting-edge
+products that meet the evolving needs of businesses across various industries.
+
+[![GitHub](https://img.shields.io/badge/GitHub-GoatBytes-181717?logo=github)](https://github.com/goatbytes)
+[![Twitter](https://img.shields.io/badge/Twitter-GoatBytes-1DA1F2?logo=twitter)](https://twitter.com/goatbytes)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-GoatBytes-0077B5?logo=linkedin)](https://www.linkedin.com/company/goatbytes)
+[![Instagram](https://img.shields.io/badge/Instagram-GoatBytes.io-E4405F?logo=instagram)](https://www.instagram.com/goatbytes.io/)

docs/overrides/partials/copyright.html

@@ -0,0 +1,8 @@
+<div class="md-copyright">
+  <div class="md-copyright__highlight">
+    © 2024. <a href="https://github.com/goatbytes/GoatStyles" target="_blank">kmmify</a>—by
+    <a href="https://goatbytes.io" target="_blank">GoatBytes.IO</a>—is licensed under <a
+      href="https://github.com/goatbytes/kmmify/blob/main/LICENSE.txt" rel="nofollow"
+      target="_blank">Apache V2.0</a>
+  </div>
+</div>

mkdocs.yml

@@ -1,70 +1,106 @@
 site_name: kmmify
-site_url: https://goatbytes.github.io/kmmify
+site_url: https://kmmify.goatbytes.io
 repo_name: kmmify
 repo_url: https://github.com/goatbytes/kmmify
 site_description: "A cutting-edge cross-platform SDK designed to streamline the process of uniquely identifying devices across different platforms."
 site_author: GoatBytes.IO
 remote_branch: gh-pages
 edit_uri: ""
 
-copyright: 'Copyright © 2024 GoatBytes.IO.'
+nav:
+  - 'Overview': index.md
+  - 'Documentation': docs/index.html
+  - 'KMP Wizard': https://kmp.jetbrains.com/
+  - 'KMP Template Gallery': https://kmp.jetbrains.com/#templateGallery
+  - 'KMP Development': https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html
 
 theme:
   name: 'material'
-  favicon: images/favicon.png
-  logo: images/logo.png
+  favicon: assets/img/favicon.png
+  logo: assets/img/logo.png
+  custom_dir: docs/overrides
+  features:
+    - instant
+    - navigation.instant
+    - navigation.sections
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    #    - toc.integrate
+    - content.code.annotate
   palette:
-    # Palette toggle for light mode
-    - scheme: default
+    - scheme: default # Palette toggle for light mode
       media: "(prefers-color-scheme: light)"
-      primary: 'deep orange'
+      primary: 'custom'
       accent: 'white'
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
-    # Palette toggle for dark mode
-    - scheme: slate
+    - scheme: slate # Palette toggle for dark mode
       media: "(prefers-color-scheme: dark)"
-      primary: 'deep orange'
+      primary: 'custom'
       accent: 'white'
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+  font:
+    heading: 'Red Hat Display'
+    text: 'Red Hat Text'
+    code: 'Red Hat Mono'
   icon:
     repo: fontawesome/brands/github
 
+markdown_extensions:
+  - admonition
+  - meta
+  - pymdownx.blocks.admonition
+  - pymdownx.blocks.tab:
+      alternate_style: true
+  - pymdownx.blocks.details
+  - pymdownx.blocks.definition
+  - pymdownx.superfences
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.mark
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - neoteroi.cards
+  - footnotes
+  - attr_list
+  - md_in_html
+
+plugins:
+  - search
+  - minify:
+      minify_html: true
+  - git-revision-date-localized:
+      type: timeago
+      fallback_to_build_date: true
+
 extra:
+  homepage: https://goatbytes.io
   social:
-    - icon: fontawesome/brands/twitter
-      link: https://twitter.com/goatbytes
+    - icon: fontawesome/brands/x-twitter
+      link: https://x.com/goatbytes
     - icon: fontawesome/brands/instagram
       link: https://instagram.com/goatbytes.io
     - icon: fontawesome/brands/github
       link: https://github.com/goatbytes
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/goatbytes
+  analytics:
+    provider: google
+    property: G-V0TQY16GNY
+  generator: false
 
 extra_css:
-  - 'css/app.css'
+  - 'assets/css/app.css'
 
-markdown_extensions:
-  - smarty
-  - codehilite:
-      guess_lang: false
-  - footnotes
-  - meta
-  - toc:
-      permalink: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.inlinehilite
-  - pymdownx.magiclink
-  - pymdownx.smartsymbols
-  - pymdownx.superfences
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.tilde
-  - tables
-
-nav:
-  - 'Overview': index.md
-  - 'Documentation': docs/index.html
+extra_javascript:
+  - 'assets/js/app.js'