feat: plugins and extensions

Author: faretek1

.github/workflows/mkdocs.yml

@@ -27,7 +27,14 @@ jobs:
           path: ~/.cache
           restore-keys: |
             mkdocs-material-
+
       - run: pip install mkdocs-material
-      - run: pip install "mkdocs-material[imaging]"
-      - run: sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
-      - run: mkdocs gh-deploy --force
+
+      - name: install plugins
+        run: |
+          pip install "mkdocs-material[imaging]"
+          sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
+
+          pip install mkdocs-glightbox
+
+      - run: mkdocs gh-deploy --force

docs/API/index.md

@@ -0,0 +1,3 @@
+# Scratch Web API
+
+insert info here

docs/contributing.md

@@ -1,3 +1,7 @@
+# README
+
 This project aims to document the Scratch API and other features, such as the sb3 file format. The source of these docs is available on [GitHub](https://github.com/scratch-api/docs).
 
-Feel free to make contributions [by opening a pull request on GitHub](https://github.com/scratch-api/docs/pulls)
+You can make contributions [by opening a pull request on GitHub](https://github.com/scratch-api/docs/pulls)
+
+The docs are licensed under [MIT](https://github.com/scratch-api/docs/blob/main/LICENSE)

docs/index.md

@@ -22,10 +22,60 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
+
+
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.instant.preview
+    - navigation.tracking
+    - navigation.tabs
+    - content.tabs.link
+    - content.tooltips
+
+
 plugins:
   - social
   - search
+  - glightbox
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - attr_list
+  - md_in_html
+  - pymdownx.superfences
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - tables
+  - footnotes
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
+  - attr_list
+  - pymdownx.blocks.caption
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true
 
 extra:
   social: