Use modern material theme for docs (Significant-Gravitas#5035)

* Use modern material theme for docs

* Update mkdocs.yml

Added search plugin

Co-authored-by: James Collins <[email protected]>

* Updating mkdocs material theme config per recommendations to enable all markdown options

* Updated highlight extension settings
and codeblocks throughout the docs to align with mkdocs-material recommendations.

codehilite is deprecated in favor of the highlight extension:
https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight

---------

Co-authored-by: lc0rp <[email protected]>
Co-authored-by: James Collins <[email protected]>
Co-authored-by: Nicholas Tindle <[email protected]>

docs/_javascript/mathjax.js

@@ -0,0 +1,16 @@
+window.MathJax = {
+    tex: {
+        inlineMath: [["\\(", "\\)"]],
+        displayMath: [["\\[", "\\]"]],
+        processEscapes: true,
+        processEnvironments: true
+    },
+    options: {
+        ignoreHtmlClass: ".*|",
+        processHtmlClass: "arithmatex"
+    }
+};
+
+document$.subscribe(() => {
+    MathJax.typesetPromise()
+})

docs/_javascript/tablesort.js

@@ -0,0 +1,6 @@
+document$.subscribe(function () {
+    var tables = document.querySelectorAll("article table:not([class])")
+    tables.forEach(function (table) {
+        new Tablesort(table)
+    })
+})

docs/challenges/memory/challenge_b.md

@@ -3,9 +3,10 @@
 **Status**: Current level to beat: level 3
 
 **Command to try**: 
-```
+
+```shell
 pytest -s tests/challenges/memory/test_memory_challenge_b.py --level=3
-``
+```
 
 ## Description
 

docs/challenges/memory/challenge_c.md

@@ -3,9 +3,10 @@
 **Status**: Current level to beat: level 1
 
 **Command to try**: 
-```
+
+```shell
 pytest -s tests/challenges/memory/test_memory_challenge_c.py --level=2
-``
+```
 
 ## Description
 
@@ -20,21 +21,36 @@ The challenge involves a series of text files containing instructions and silly
 
 - `instructions_1.txt`
 
-The current phrase is "The purple elephant danced on a rainbow while eating a taco.".\n[NOISE intended to confuse the agent]
-Read the file instructions_2.txt using the read_file command.
+The current phrase is 
+
+```
+The purple elephant danced on a rainbow while eating a taco.\n[NOISE intended to confuse the agent]
+```
+
+Read the file `instructions_2.txt` using the read_file command.
 
 
 - `instructions_2.txt`
 
-The current phrase is "The sneaky toaster stole my socks and ran away to Hawaii.".\n[NOISE intended to confuse the agent]
+The current phrase is 
+
+```
+The sneaky toaster stole my socks and ran away to Hawaii.\n[NOISE intended to confuse the agent]
+```
+
 Read the file instructions_3.txt using the read_file command.
 
 
 ...and so on.
 
 - `instructions_n.txt`
 
-The current phrase is "My pet rock sings better than Beyoncé on Tuesdays."
+The current phrase is 
+
+```
+My pet rock sings better than Beyoncé on Tuesdays.
+```
+
 Write all the phrases into the file output.txt. The file has not been created yet. After that, use the task_complete command.
 
 

docs/challenges/memory/challenge_d.md

@@ -1,11 +1,12 @@
-# Memory Challenge C
+# Memory Challenge D
 
 **Status**: Current level to beat: level 1
 
 **Command to try**: 
-```
+
+```shell
 pytest -s tests/challenges/memory/test_memory_challenge_d.py --level=1
-``
+```
 
 ## Description
 
@@ -30,20 +31,24 @@ The test runs for levels up to the maximum level that the AI has successfully be
 
 - `instructions_1.txt`
 
-"Sally has a marble (marble A) and she puts it in her basket (basket S), then leaves the room. Anne moves marble A from Sally's basket (basket S) to her own basket (basket A).",
+```
+Sally has a marble (marble A) and she puts it in her basket (basket S), then leaves the room. Anne moves marble A from Sally's basket (basket S) to her own basket (basket A).
+```
 
 
 - `instructions_2.txt`
 
-"Sally gives a new marble (marble B) to Bob who is outside with her. Bob goes into the room and places marble B into Anne's basket (basket A). Anne tells Bob to tell Sally that he lost the marble b. Bob leaves the room and speaks to Sally about the marble B. Meanwhile, after Bob left the room, Anne moves marble A into the green box, but tells Charlie to tell Sally that marble A is under the sofa. Charlie leaves the room and speak to Sally about the marble A as instructed by Anne.",
-
+```
+Sally gives a new marble (marble B) to Bob who is outside with her. Bob goes into the room and places marble B into Anne's basket (basket A). Anne tells Bob to tell Sally that he lost the marble b. Bob leaves the room and speaks to Sally about the marble B. Meanwhile, after Bob left the room, Anne moves marble A into the green box, but tells Charlie to tell Sally that marble A is under the sofa. Charlie leaves the room and speak to Sally about the marble A as instructed by Anne.
+```
 
 ...and so on.
 
 - `instructions_n.txt`
 
 The expected believes of every characters are given in a list:
 
+```json
 expected_beliefs = {
     1: {
         'Sally': {
@@ -68,7 +73,7 @@ expected_beliefs = {
             'A': 'sofa',  # Because Anne told him to tell Sally so
         }
     },...
-
+```
 
 ## Objective
 

docs/configuration/imagegen.md

@@ -7,7 +7,8 @@
 ## DALL-e
 
 In `.env`, make sure `IMAGE_PROVIDER` is commented (or set to `dalle`):
-``` ini
+
+```ini
 # IMAGE_PROVIDER=dalle    # this is the default
 ```
 
@@ -23,7 +24,8 @@ To use text-to-image models from Hugging Face, you need a Hugging Face API token
 Link to the appropriate settings page: [Hugging Face > Settings > Tokens](https://huggingface.co/settings/tokens)
 
 Once you have an API token, uncomment and adjust these variables in your `.env`:
-``` ini
+
+```ini
 IMAGE_PROVIDER=huggingface
 HUGGINGFACE_API_TOKEN=your-huggingface-api-token
 ```
@@ -39,7 +41,8 @@ Further optional configuration:
 ## Stable Diffusion WebUI
 
 It is possible to use your own self-hosted Stable Diffusion WebUI with Auto-GPT:
-``` ini
+
+```ini
 IMAGE_PROVIDER=sdwebui
 ```
 
@@ -54,6 +57,7 @@ Further optional configuration:
 | `SD_WEBUI_AUTH` | `{username}:{password}` | *Note: do not copy the braces!*  |
 
 ## Selenium
-``` shell
+
+```shell
 sudo Xvfb :10 -ac -screen 0 1024x768x24 & DISPLAY=:10 <YOUR_CLIENT>
 ```

docs/configuration/memory.md

@@ -51,17 +51,19 @@ Links to memory backends
 
 1. Launch Redis container
 
-        :::shell
-        docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
+    ```shell
+    docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
+    ```
 
 3. Set the following settings in `.env`
 
-        :::ini
-        MEMORY_BACKEND=redis
-        REDIS_HOST=localhost
-        REDIS_PORT=6379
-        REDIS_PASSWORD=<PASSWORD>
-
+    ```shell
+    MEMORY_BACKEND=redis
+    REDIS_HOST=localhost
+    REDIS_PORT=6379
+    REDIS_PASSWORD=<PASSWORD>
+    ```
+
     Replace `<PASSWORD>` by your password, omitting the angled brackets (<>).
 
     Optional configuration:
@@ -157,15 +159,15 @@ To enable it, set `USE_WEAVIATE_EMBEDDED` to `True` and make sure you `pip insta
 
 Install the Weaviate client before usage.
 
-``` shell
+```shell
 $ pip install weaviate-client
 ```
 
 #### Setting up environment variables
 
 In your `.env` file set the following:
 
-``` ini
+```ini
 MEMORY_BACKEND=weaviate
 WEAVIATE_HOST="127.0.0.1" # the IP or domain of the running Weaviate instance
 WEAVIATE_PORT="8080" 
@@ -195,7 +197,7 @@ View memory usage by using the `--debug` flag :)
 
 Memory pre-seeding allows you to ingest files into memory and pre-seed it before running Auto-GPT.
 
-``` shell
+```shell
 $ python data_ingestion.py -h 
 usage: data_ingestion.py [-h] (--file FILE | --dir DIR) [--init] [--overlap OVERLAP] [--max_length MAX_LENGTH]
 

docs/configuration/voice.md

@@ -2,7 +2,7 @@
 
 Enter this command to use TTS _(Text-to-Speech)_ for Auto-GPT
 
-``` shell
+```shell
 python -m autogpt --speak
 ```