Apply just-the-docs theme for docs-site

Author: syntaxerror247

.github/workflows/docs-site.yml

@@ -0,0 +1,63 @@
+name: Deploy docs site
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "docs/**"
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+          working-directory: '${{ github.workspace }}/docs'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
+# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+
+gem "just-the-docs", "0.10.1" # pinned to the current release
+# gem "just-the-docs"        # always download the latest release

docs/_config.yml

@@ -0,0 +1,15 @@
+title: Godot Firebase Android
+description: Documentation for the GodotFirebaseAndroid plugin
+theme: just-the-docs
+color_scheme: dark
+
+url: https://syntaxerror247.github.io
+
+aux_links:
+  Plugin Repository: https://github.com/syntaxerror247/GodotFirebaseAndroid
+
+# Footer content
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: 'Copyright &copy; 2025 Anish Mishra. Distributed by an <a href="https://github.com/syntaxerror247/GodotFirebaseAndroid/blob/main/LICENSE">MIT license.</a>'

docs/authentication.md

@@ -1,3 +1,9 @@
+---
+layout: default
+title: Authentication
+nav_order: 2
+---
+
 # Authentication
 
 The Firebase Authentication module in **GodotFirebaseAndroid** supports anonymous login, email/password login, Google login, and account management. Each method emits signals to indicate success or failure.
@@ -7,7 +13,7 @@ The Firebase Authentication module in **GodotFirebaseAndroid** supports anonymou
 - `auth_success(current_user_data: Dictionary)`
   Emitted when a user successfully signs in. The dictionary contains user information such as UID, email, etc.
 
-- `auth_failure(error_mplugin.emitGodotSignal("realtime_db_value_changed", path, data)essage: String)`
+- `auth_failure(error_message: String)`
   Emitted when an authentication operation fails.
 
 - `sign_out_success(success: bool)`
@@ -24,8 +30,11 @@ The Firebase Authentication module in **GodotFirebaseAndroid** supports anonymou
 
 ## Methods
 
-### `sign_in_anonymously()`
+{: .text-green-100 }
+### sign_in_anonymously()
+
 Signs in the user anonymously.
+
 **Emits:** `auth_success` or `auth_failure`.
 
 ```gdscript
@@ -34,8 +43,11 @@ Firebase.auth.sign_in_anonymously()
 
 ---
 
-### `create_user_with_email_password(email: String, password: String)`
+{: .text-green-100 }
+### create_user_with_email_password(email: String, password: String)
+
 Creates a new user with the given email and password.
+
 **Emits:** `auth_success` or `auth_failure`.
 
 ```gdscript
@@ -44,73 +56,95 @@ Firebase.auth.create_user_with_email_password("[email protected]", "password123
 
 ---
 
-### `sign_in_with_email_password(email: String, password: String)`
+{: .text-green-100 }
+### sign_in_with_email_password(email: String, password: String)
+
 Signs in a user using email and password credentials.
+
 **Emits:** `auth_success` or `auth_failure`.
 
 ```gdscript
 Firebase.auth.sign_in_with_email_password("[email protected]", "password123")
 ```
 ---
 
-### `send_password_reset_email(email: String)`
+{: .text-green-100 }
+### send_password_reset_email(email: String)
+
 Sends a password reset email to the specified address.
+
 **Emits:** `password_reset_sent`. It also emits `auth_failure` on failure.
 
 ```gdscript
 Firebase.auth.send_password_reset_email("[email protected]")
 ```
 ---
 
-### `send_email_verification()`
+{: .text-green-100 }
+### send_email_verification()
+
 Sends an email verification to the currently signed-in user.
+
 **Emits:** `email_verification_sent`. It also emits `auth_failure` on failure.
 
 ```gdscript
 Firebase.auth.send_email_verification()
 ```
 ---
 
-### `sign_in_with_google()`
+{: .text-green-100 }
+### sign_in_with_google()
+
 Signs in the user using Google. Ensure Google Sign-In is properly configured in the Firebase console.
+
 **Emits:** `auth_success` or `auth_failure`.
 
 ```gdscript
 Firebase.auth.sign_in_with_google()
 ```
 ---
 
-### `get_current_user_data() -> Dictionary`
+{: .text-green-100 }
+### get_current_user_data() -> Dictionary
+
 If no user is signed in, returns an dictionary with error.
+
 **Returns** a dictionary containing the currently signed-in user's data.
 
 ```gdscript
 Firebase.auth.get_current_user_data()
 ```
 ---
 
-### `delete_current_user()`
+{: .text-green-100 }
+### delete_current_user()
+
 Deletes the currently signed-in user.
+
 **Emits:** `user_deleted`. It also emits `auth_failure` on failure.
 
 ```gdscript
 Firebase.auth.delete_current_user()
 ```
 ---
 
-### `is_signed_in() -> bool`
+{: .text-green-100 }
+### is_signed_in() -> bool
+
 **Returns** `true` if a user is currently signed in, otherwise `false`.
 
 ```gdscript
 Firebase.auth.is_signed_in()
 ```
 ---
 
-### `sign_out()`
-Signs out the current user.  
+{: .text-green-100 }
+### sign_out()
+
+Signs out the current user.
+
 **Emits:** `sign_out_success`. It also emits `auth_failure` on failure.
 
 ```gdscript
 Firebase.auth.sign_out()
 ```
----

docs/firestore.md

@@ -1,22 +1,28 @@
+---
+layout: default
+title: Cloud Firestore
+nav_order: 3
+---
+
 # Cloud Firestore
 
 The Cloud Firestore module in **GodotFirebaseAndroid** supports adding, retrieving, updating, and deleting documents, as well as listening for document changes.
 
 ## Signals
 
--`write_task_completed(result: Dictionary)`
+- `write_task_completed(result: Dictionary)`
   Emitted after adding or setting a document.
 
--`get_task_completed(result: Dictionary)`
+- `get_task_completed(result: Dictionary)`
   Emitted after retrieving a document or a list of documents.
 
--`update_task_completed(result: Dictionary)`
+- `update_task_completed(result: Dictionary)`
   Emitted after updating a document.
 
--`delete_task_completed(result: Dictionary)`
+- `delete_task_completed(result: Dictionary)`
   Emitted after deleting a document.
 
--`document_changed(document_path: String, data: Dictionary)`
+- `document_changed(document_path: String, data: Dictionary)`
   Emitted when a listened document is changed.
 
 **Note**: All signal result dictionaries contain the following keys:
@@ -31,7 +37,8 @@ The Cloud Firestore module in **GodotFirebaseAndroid** supports adding, retrievi
 
 ## Methods
 
-### `add_document(collection: String, data: Dictionary)`
+{: .text-green-100 }
+### add_document(collection: String, data: Dictionary)
 
 Adds a new document to the specified collection with an auto-generated ID.
 **Emits:** `write_task_completed`
@@ -42,7 +49,8 @@ Firebase.firestore.add_document("players", {"name": "Alice", "score": 100})
 
 ---
 
-### `set_document(collection: String, documentId: String, data: Dictionary, merge: bool = false)`
+{: .text-green-100 }
+### set_document(collection: String, documentId: String, data: Dictionary, merge: bool = false)
 
 Sets data for a document. If the document exists, it will be overwritten unless `merge` is `true`.
 **Emits:** `write_task_completed`
@@ -53,7 +61,8 @@ Firebase.firestore.set_document("players", "user_123", {"score": 150}, true)
 
 ---
 
-### `get_document(collection: String, documentId: String)`
+{: .text-green-100 }
+### get_document(collection: String, documentId: String)
 
 Retrieves a single document from the specified collection.
 **Emits:** `get_task_completed`
@@ -64,7 +73,8 @@ Firebase.firestore.get_document("players", "user_123")
 
 ---
 
-### `get_documents_in_collection(collection: String)`
+{: .text-green-100 }
+### get_documents_in_collection(collection: String)
 
 Retrieves all documents in a given collection.
 **Emits:** `get_task_completed`
@@ -75,7 +85,8 @@ Firebase.firestore.get_documents_in_collection("players")
 
 ---
 
-### `update_document(collection: String, documentId: String, data: Dictionary)`
+{: .text-green-100 }
+### update_document(collection: String, documentId: String, data: Dictionary)
 
 Updates fields in a document without overwriting the entire document.
 **Emits:** `update_task_completed`
@@ -86,7 +97,8 @@ Firebase.firestore.update_document("players", "user_123", {"score": 200})
 
 ---
 
-### `delete_document(collection: String, documentId: String)`
+{: .text-green-100 }
+### `delete_document(collection: String, documentId: String)
 
 Deletes a document from the specified collection.
 **Emits:** `delete_task_completed`
@@ -97,7 +109,8 @@ Firebase.firestore.delete_document("players", "user_123")
 
 ---
 
-### `listen_to_document(documentPath: String)`
+{: .text-green-100 }
+### listen_to_document(documentPath: String)
 
 Starts listening to changes on a specific document path.
 **Emits:** `document_changed`
@@ -108,7 +121,8 @@ Firebase.firestore.listen_to_document("players/user_123")
 
 ---
 
-### `stop_listening_to_document(documentPath: String)`
+{: .text-green-100 }
+### stop_listening_to_document(documentPath: String)
 
 Stops listening to changes for a document path.
 

docs/index.md

@@ -1,3 +1,9 @@
+---
+layout: default
+title: Firebase Android
+nav_order: 1
+---
+
 # GodotFirebaseAndroid
 
 **GodotFirebaseAndroid** is an Android plugin for the Godot Engine that integrates Firebase services in Godot Android games and apps.
@@ -27,14 +33,6 @@
    - Open **Project > Export**
    - Enable `gradle_build/use_gradle_build` in Android preset.
 
-## Documentation
-
-- [Authentication](authentication.md)
-- [Cloud Firestore](firestore.md)
-- [Realtime Database](realtime_database.md)
-- [Cloud Storage](storage.md)
-- [Cloud Messaging](messaging.md)
-
 ## License
 
 MIT License