Add examples page to docs

acatiadroid · Jan 2, 2024 · 72b8459 · 72b8459
1 parent 694975b
commit 72b8459
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1 @@
+theme: jekyll-theme-minimal
diff --git a/docs/api.md b/docs/api.md
@@ -16,9 +16,9 @@ The base class for all Bloxlink API interactions.
     Looks up a Roblox user from the given Discord ID (and optional server ID).
     Returns the Roblox user ID.
 
-    roblox_id - the Roblox ID of the user you want to find the Discord ID of.
-
-    server_id* - the ID of the server you want to search in.
+    **Parameters:**
+    * **discord_id (int)**: the Roblox ID of the user you want to find the Discord ID of.
+    * **server_id (int)**: the ID of the server you want to search in.
 
     \**if you intend on doing a global search (which required approval), do not include this argument.
     Otherwise, you must provide this argument.*
@@ -28,8 +28,7 @@ The base class for all Bloxlink API interactions.
     Looks up a Discord user from the given Roblox ID (and optional server ID).
     Returns the Discord user ID.
 
-    Attributes:
-
+    **Parameters:**   
     * **roblox_id (int)**: the ID of the Discord user you want to find the Roblox ID of.
     * **server_id (int)***: the ID of the server you want to search in.
 

diff --git a/examples.md → docs/examples.md b/examples.md → docs/examples.md
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@
 * [API Reference](api.md)
 * [GitHub Page](https://github.com/acatiadroid/pybloxlink)
 * [PyPI Page](https://pypi.org/project/pybloxlink/)
-* [Examples](https://github.com/acatiadroid/pybloxlink/blob/main/examples.md)
+* [Examples](examples.md)
 
 ## About
 PyBloxlink is an async API wrapper for the [Bloxlink](https://blox.link) API.